ReadAttributeComment linia 374, TSInfoFiles.pp
public function ReadAttributeComment(const AAttrPath, ADelimiter: String; AType: TCommentType): String;
Metoda służąca do odczytu komentarza atrybutu.
| parametry | |
|---|---|
| AAttrPath | ciąg znaków ze ścieżką lub samą nazwą atrybutu |
| ADelimiter | ciąg znaków określający separator linii komentarza atrybutu |
| AType | wartość typu TCommentType, określająca typ komentarza |
| wartość zwracana | |
| String | łańcuch znaków, zawierający komentarz atrybutu |
Służy do odczytu komentarza deklaracji lub definicji atrybutu, do którego ścieżka lub nazwa przekazana jest w parametrze AAttrPath. 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ę.
Argument AType typu TCommentType określa typ komentarza atrybutu, który zostanie odczytany.
| typ | określa |
|---|---|
| ctDeclaration | komentarz deklaracji atrybutu |
| ctDefinition | komentarz definicji referencjonowanego atrybutu |
Jeżeli argument ten zawiera wartość ctDeclaration, metoda zwróci komentarz deklaracji atrybutu. W przeciwnym razie, jeśli zawiera wartość ctDefinition, zwróci komentarz definicji atrybutu referencjonowanego, bez względu na jego stan referencjonowania.
Metoda wywołuje wyjątek klasy ETSInfoFileException, w przypadku gdy atrybut o podanej ścieżce lub nazwie nie istnieje w drzewie.
zobacz też: