Method GetDescriptionParameter
GetDescriptionParameter(DocumentId)
Gets the description parameter entity of a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetDescriptionParameter(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the description parameter entity found. |
Remarks
The description parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, string) methods.
This method is available since v7.6.