bool Insert_Node(Construct_Identifier Construct_ID, long Relative_Position);

Parameters

• Construct_Identifier Construct_ID: A construct identifier (generally name or UID).
• long Relative_Position: A relative child position.

Return Values

• True: Successful insertion.
• False: Error.

Remarks

This function inserts a node as a child of the current node, with Construct_ID representing the construct type of the new node, and Relative_Position representing the insertion point of the new node.

The new node is inserted before the node indicated by Relative_Position, a zero-based index. If the value of Relative_Position equals the value returned by Get_Child_Count, the new node becomes the last child in the sequence.

Construct_ID is a platform-dependent identifier.

If the construct type of the new node is an organized block or bit scan block and has a header structure, the header structure is automatically created as the first child of the new node, and the structure’s values are initialized to their defaults as defined in the implementation file.

If the construct type of the new node is a block but the implementation file did not specify a header structure for the new node, the node starts empty (zero bytes, no children).

If the construct type of the new node is a data structure, the structure’s data members are created automatically and initialized to their defaults as defined in the implementation file.

The function can fail for any of the following reasons.

• No file was loaded.
• Construct_ID is not a valid identifier for a construct.
• Relative_Position is negative.
• Relative_Position is greater than the number of children of the current node.
• Relative_Position is zero and the current node has a header structure.
• The construct type of the new node is node list or decision list.
• The construct type of the new node is a structure containing pointers.
• The construct type of the current node is not organized block.
• There were not enough node handles to complete the operation.
• There was not enough memory to complete the operation.

Compatibility

	All Platforms	Win32 C++ LIB
BAR version	1.1	1.1
	All Platforms	Win32
BARfly version	1.0	1.0

  See also:  [BAR type lookup functions] [BAR loading and saving functions] [BAR node navigation functions]
[BAR node information functions] [BAR data reading functions] [BAR data writing functions] [BAR miscellaneous functions]