ReadChildNodeComment linia 375, TSInfoFiles.pp
public function ReadChildNodeComment(const ANodePath, ADelimiter: String; AType: TCommentType): String;
Metoda umożliwiająca odczyt komentarza węzła potomnego.
parametry | |
---|---|
ANodePath | łańcuch znaków, zawierający ścieżkę lub samą nazwę węzła potomnego |
ADelimiter | ciąg znaków, określający separator linii komentarza węzła |
AType | wartość typu TCommentType, określająca typ komentarza |
wartość zwracana | |
String | łańcuch znaków, zawierający komentarz węzła potomnego |
Służy do odczytu komentarza deklaracji lub definicji węzła potomnego, do którego ścieżka lub nazwa przekazana jest w parametrze ANodePath. Wykorzystuje łańcuch znaków podany w argumencie ADelimiter do wstawienia separatorów w miejsca występowania znaków separatora wartości, określonego przez stałą VALUES_DELIMITER. Jeżeli komentarz zawiera wartość jednoliniową, argument ADelimiter powinien zawierać pusty łańcuch. W przeciwnym razie w miejsca znaków separatora wartości zostaną podstawione ciągi z parametru, przed zwróceniem komentarza przez metodę.
Typ komentarza określa argument AType typu TCommentType.
typ | określa |
---|---|
ctDeclaration | komentarz deklaracji węzła potomnego |
ctDefinition | komentarz definicji referencjonowanego węzła potomnego |
Jeśli parametr ten zawiera wartość ctDeclaration, metoda zwróci komentarz deklaracji węzła potomnego. W przeciwnym razie, jeżeli zawiera wartość ctDefinition, zwróci komentarza definicji węzła referencjonowanego, bez względu na jego stan referencjonowania.
Jeżeli parametr ANodePath zawiera pusty łańcuch, próba odczytania komentarza zadanego typu zostanie przeprowadzona na węźle z pola FCurrentNode. W przypadku gdy pole to zawiera wskazanie na główny węzeł drzewa, odczyt komentarza spowoduje wywołanie wyjątku.
Metoda wywołuje wyjątek klasy ETSInfoFileException, jeżeli węzeł potomny o podanej ścieżce lub nazwie nie istnieje w drzewie, a także podczas próby odczytu komentarza z głównego węzła drzewa.
zobacz też: