WriteChildNodeComment linia 371, TSInfoFiles.pp
public procedure WriteChildNodeComment(const ANodePath, AComment, ADelimiter: String; AType: TCommentType);
Metoda służąca do ustawienia komentarza węzła potomnego.
parametry | |
---|---|
ANodePath | łańcuch znaków zawierający ścieżkę lub nazwę węzła potomnego |
AComment | łańcuch zawierający nowy komentarz węzła |
ADelimiter | ciąg znaków, określający separator linii komentarza |
AType | wartość wyliczeniowa typu TCommentType, określająca typ komentarza węzła |
Służy do zapisu nowej wartości komentarza węzła potomnego, do którego ścieżka lub nazwa podana jest w parametrze ANodePath. Jeżeli nowy komentarz węzła podany w argumencie AComment ma być jednoliniowy, parametr ADelimiter powinien zawierać pusty łańcuch. W przeciwnym razie parametr ten powinien posiadać ciąg znaków, według którego łańcuch wejściowy zostanie podzielony na składowe. Do oznaczenia łańcucha komentarza jako wartości wieloliniowej, wykorzystywana jest funkcja ReplaceSubStrings.
Argument AType typu TCommentType określa typ komentarza węzła, który zostanie zmodyfikowany.
typ | określa |
---|---|
ctDeclaration | komentarz deklaracji węzła potomnego |
ctDefinition | komentarz definicji referencjonowanego węzła potomnego |
Jeżeli argument ten zawiera wartość ctDeclaration, metoda zmodyfikuje komentarz deklaracji węzła potomnego. W przeciwnym razie, jeśli przyjmuje wartość ctDefinition, metoda zaktualizuje komentarz definicji referencjonowanego węzła potomnego, bez względu na jego stan referencjonowania.
Jeśli argument AComment zawiera pusty łańcuch znaków, zadany komentarz węzła zostanie skasowany.
Metoda wywołuje wyjątek klasy ETSInfoFileException, jeżeli węzeł docelowy nie istnieje lub nie jest węzłem potomnym (jest głównym węzłem drzewa), a także jeśli tryb tylko do odczytu jest aktualnie włączony.
zobacz też: