$parent
Get or set the parent of the Struct node.
Struct->$parent
Return Values
Return Value |
Meaning |
---|---|
Reference to the parent Struct |
Reference to the Struct of which Struct is a member. |
|
Returned if one the following is true:
|
Value |
Error Constant |
Meaning |
---|---|---|
|
|
Struct does not refer to a Stuct |
|
|
Structs do not have a common name or parent |
|
|
Tried to assign a Struct node to multiple parents. |
|
|
Not a valid Struct member type |
|
|
Tried to move the Struct to a descendent of its current parent. |
|
|
Tried to move the Struct to a $tags Struct of another Struct |
Description
You use the $parent function to:
-
Get the parent of a Struct member, or get the parent of a collection of Structs that have the same parent. If the Structs have different parents, an error is returned in $procerror.
-
Detach a Struct node from its parent, making it a top node. For example:
vStruct->$parent = ""
-
Move a Struct node to another Struct. For example:
vStructA->$parent = vStructB
This detaches the node StructA from its current parent and adds it as a member of StructB.
Version |
Change |
---|---|
9.5.01 |
Introduced |