Returns the description text of an item.
Syntax
Rep_GetItemDescription(string sessionId,string systemName, string objectId,string objectName, string objectType,out string xmlResult)
| Parameter | Description |
|---|---|
| sessionId | Valid session identifier. |
| systemName | SystemOId of the system. |
| objectId | ID of the object for which you want the description text. If this parameter is not set, the parameter ObjectName and ObjectType must be set. |
| objectName | Name of the object for which you want the description text. If the parameter ObjectName is set, the ObjectType must also be set. |
| objectType | Type of object for which you want the description text. |
| xmlResult | XML serialized MwsItemDescription object or MwsError in the event of an error. |
Return Value
| Value | Description |
|---|---|
| 0 | OK |
| <>0 |
Error See Error Codes. |
Example
<mws xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" type="ITEMDESCRIPTION" version="2.0">
<itemdescription>
<description>This is the description of this text block</description>
<objectname>MyTextBlock</objectname>
<objectid>04062014-1744-tc-s</objectid>
<databaseid>22306</databaseid>
<objecttype>TextComponent</objecttype>
</itemdescription>
</mws>