WriteAttributeComment linia 370, TSInfoFiles.pp
public procedure WriteAttributeComment(const AAttrPath, AComment, ADelimiter: String; AType: TCommentType);
Metoda pozwalająca na ustawienie komentarza atrybutu.
| parametry | |
|---|---|
| AAttrPath | łańcuch znaków zawierający ścieżkę lub nazwę atrybutu |
| AComment | łańcuch zawierający nowy komentarz atrybutu |
| ADelimiter | ciąg znaków określający separator linii komentarza |
| AType | wartość wyliczeniowa typu TCommentType, określająca typ komentarza do modyfikacji |
Służy do zapisu nowej wartości komentarza atrybutu, do którego ścieżka lub nazwa podana jest w parametrze AAttrPath. Jeżeli nowy komentarz atrybutu podany w argumencie AComment ma być jednoliniowy, argument 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 atrybutu, który zostanie zmodyfikowany.
| typ | określa |
|---|---|
| ctDeclaration | komentarz deklaracji atrybutu |
| ctDefinition | komentarz definicji referencjonowanego atrybutu |
Jeżeli argument ten zawiera wartość ctDeclaration, metoda zmodyfikuje komentarz deklaracji atrybutu. W przeciwnym razie, jeśli zawiera wartość ctDefinition, metoda zaktualizuje komentarz definicji atrybutu referencjonowanego, bez względu na jego stan referencjonowania.
W przypadku gdy argument AComment zawiera pusty łańcuch znaków, zadany komentarz atrybutu zostanie skasowany.
Metoda wywołuje wyjątek klasy ETSInfoFileException, jeżeli atrybut docelowy nie istnieje lub jeśli jest włączony tryb tylko do odczytu.
zobacz też: