OpenNI 1.3.2
|
Typedefs | |
typedef struct XnModuleError * | XnEnumerationErrorsIterator |
typedef struct XnEnumerationErrors | XnEnumerationErrors |
This page details functions for managing an Enumeration Errors object.
The following code iterates over an enumeration errors object:
typedef struct XnEnumerationErrors XnEnumerationErrors |
An object that holds errors during an enumeration process.
typedef struct XnModuleError* XnEnumerationErrorsIterator |
Represents an iterator for an XnEnumerationErrors object.
XN_C_API XnStatus XN_C_DECL xnEnumerationErrorsAdd | ( | XnEnumerationErrors * | pErrors, |
const XnProductionNodeDescription * | pDesc, | ||
XnStatus | nError | ||
) |
Adds an error to the object.
pErrors | [in] Enumeration Errors object. |
pDesc | [in] Description of the failing module. |
nError | [in] The enumeration error that occurred. |
XN_C_API XnStatus XN_C_DECL xnEnumerationErrorsAllocate | ( | XnEnumerationErrors ** | ppErrors | ) |
Allocates an enumeration errors object.
ppErrors | [out] The allocated object |
XN_C_API XnStatus XN_C_DECL xnEnumerationErrorsClear | ( | XnEnumerationErrors * | pErrors | ) |
Clears an Enumeration Errors object from all errors in it.
pErrors | [in] Enumeration Errors object. |
XN_C_API void XN_C_DECL xnEnumerationErrorsFree | ( | const XnEnumerationErrors * | pErrors | ) |
Frees an enumeration errors object
pErrors | [in] Parameter description |
XN_C_API const XnProductionNodeDescription* XN_C_DECL xnEnumerationErrorsGetCurrentDescription | ( | XnEnumerationErrorsIterator | it | ) |
Gets the description of the node from current error.
it | [in] The iterator to the error. |
XN_C_API XnStatus XN_C_DECL xnEnumerationErrorsGetCurrentError | ( | XnEnumerationErrorsIterator | it | ) |
Gets the enumeration error caused when enumerating the node.
it | [in] The iterator to the error. |
XN_C_API XnEnumerationErrorsIterator XN_C_DECL xnEnumerationErrorsGetFirst | ( | const XnEnumerationErrors * | pErrors | ) |
Gets an iterator to the first error in the object.
pErrors | [in] Enumeration Errors object. |
XN_C_API XnEnumerationErrorsIterator XN_C_DECL xnEnumerationErrorsGetNext | ( | XnEnumerationErrorsIterator | it | ) |
Gets an iterator to the next error in the object.
it | [in] An iterator to an error in the object. |
XN_C_API XnBool XN_C_DECL xnEnumerationErrorsIteratorIsValid | ( | XnEnumerationErrorsIterator | it | ) |
Checks if an iterator is valid (i.e. points to a real error)
it | [in] The iterator to check. |
XN_C_API XnStatus XN_C_DECL xnEnumerationErrorsToString | ( | const XnEnumerationErrors * | pErrors, |
XnChar * | csBuffer, | ||
XnUInt32 | nSize | ||
) |
Returns a string representation of the Enumeration Errors object.
pErrors | [in] Enumeration Errors object. |
csBuffer | [in] A char buffer to be filled. |
nSize | [in] Size of the char buffer. |