Detailed Description
This page describes the functionality of a production node info object. Each info object can represent a possible production node, or an existing one.
Function Documentation
Allocates a node info object, and sets its details.
- Parameters
-
pDescription | [in] The description for the new node info object. |
strCreationInfo | [in] The creation info for the new node info object. |
pNeededNodes | [in] A list of node info's that are needed by the new node info. |
ppNodeInfo | [out] A pointer to pointer to the new node info object. |
Frees a node info object
- Parameters
-
pNodeInfo | [in] The node info object to free. |
Gets the additional data object attached to the node info object.
- Parameters
-
pNodeInfo | [in] A production node info object. |
Gets the creation info of the production node.
- Parameters
-
pNodeInfo | [in] A production node info object. |
Gets the description of the production node.
- Parameters
-
pNodeInfo | [in] A production node info object. |
Gets the instance name of the production node.
- Parameters
-
pNodeInfo | [in] A production node info object. |
Gets the list of needed nodes of the production node.
- Parameters
-
pNodeInfo | [in] A production node info object. |
Gets the handle of the production node. For nodes that weren't created yet, NULL is returned. If a handle is returned, it should be released when no longer used by calling xnProductionNodeRelease().
- Parameters
-
pNodeInfo | [in] A production node info object. |
Creates a printable representation of the production tree.
- Parameters
-
pNodeInfo | [in] A production node info object. |
csResult | [in] A buffer to be filled with the printable representation. |
nSize | [in] Size of the buffer. |
Sets the instance name of the node info object. The name can only be set BEFORE the instance is created.
- Parameters
-
pNodeInfo | [in] A production node info object. |
strInstanceName | [in] The name to give to this instance. |