Tree.getInfo (Method)
Returns a structure describing the information of a tree.
Returns:
Tree_GetInfo_Result (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| BoundSubsiteIDs | SubsiteIDList_EmptyString | Comma-delimited list of subsite IDs to bind with this tree, or empty string if no bindings. |
| Description | PlainText_2000 | The description of the tree. |
| FamilyID | TreeFamilyID | The family id of the tree. |
| ID | TreeID | The unique ID of the tree. |
| Name | TreeName | The name of the tree. |
| Properties | Struct | The property values for the tree. |
| State | ActiveInactive | The state of the tree, i.e. 'Active' or 'Inactive'. |
| TypeDescription | PlainText_2000 | The description of the tree type. |
| TypeID | TreeTypeID | The unique ID of the tree type. |
| TypeName | PlainText_NonNull_100 | The name of the tree type. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| id | TreeID | Required | The unique ID of a tree to return the information for. |
Context:
| License Requirements | (none) |
| Permission Requirements | (none) |
| Deny Context | (none) |
| Require Context | (none) |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None