Get Related Node ID
This system function returns the ID of a node related to a reference node.
Parameters
- Parent Child
-
Input, required. The parent child FC to affect.
- Current node ID
-
Input, required. The ID of node to use as a reference. Set the parameter to an applicable object from the object list.
- Relation
-
Input, required. The relationship of the target node to the reference node. Set the parameter to <Parent Node>, <First Child Node>, <Next Sibling Node>, <Previous Sibling Node>.
- Node ID
-
Output, required. The object to which you want to assign the return value that designates the node ID. The value must be a variable or control with the same data type as the node ID column; a type mismatch will be checked by the runtime engine. Set the parameter to an applicable object from the object list.
- Error Code
-
Output, required. The object to which you want to assign the return value that designates the error code for the transaction. The value must be integer type variable or control. Set the parameter to an applicable object from the object list.
Returns
This system code returns two values. The node ID itself is returned to the object identified by Node ID. A value indicating whether the node was actually found is sent to the object identified by Error Code and can have one of two values:
- 0
-
The node ID was found successfully.
- Nonzero value
-
The node ID was not found.