Switches the status of an object and returns the modified structure.
The function returns the modified structure after all respective dependent toggle actions have been executed.
Note: Toggling objects based on groups and actions can lead to other objects being automatically toggled as well.
Syntax
Obj_Toggle(string sessionId,string processId,string objRef, string rootRef,int maxLevel,out string xmlResult)
| Parameter | Description |
|---|---|
| sessionId | Valid session identifier (SessionId) |
| processId | ID of the process of which the object is being referenced. |
| objRef | Reference of the object to be toggled. |
| rootRef | Object reference whose structure is to be returned after the call |
| maxLevel | Determines how many levels are to be returned (-1 = all) |
| xmlResult | The structure of the object, if successful. |
Return Value
| Value | Description |
|---|---|
| 0 | OK |
| <>0 |
Error See Error Codes. |