Typedefs | Functions

Enumeration Errors
[C Reference]

Typedefs

typedef struct XnModuleError * XnEnumerationErrorsIterator
typedef struct XnEnumerationErrors XnEnumerationErrors

Functions

XN_C_API XnStatus xnEnumerationErrorsAllocate (XnEnumerationErrors **ppErrors)
XN_C_API void xnEnumerationErrorsFree (const XnEnumerationErrors *pErrors)
XN_C_API XnStatus xnEnumerationErrorsAdd (XnEnumerationErrors *pErrors, const XnProductionNodeDescription *pDesc, XnStatus nError)
XN_C_API XnStatus xnEnumerationErrorsToString (const XnEnumerationErrors *pErrors, XnChar *csBuffer, XnUInt32 nSize)
XN_C_API XnStatus xnEnumerationErrorsClear (XnEnumerationErrors *pErrors)
XN_C_API
XnEnumerationErrorsIterator 
xnEnumerationErrorsGetFirst (const XnEnumerationErrors *pErrors)
XN_C_API
XnEnumerationErrorsIterator 
xnEnumerationErrorsGetNext (XnEnumerationErrorsIterator it)
XN_C_API XnBool xnEnumerationErrorsIteratorIsValid (XnEnumerationErrorsIterator it)
XN_C_API const
XnProductionNodeDescription
xnEnumerationErrorsGetCurrentDescription (XnEnumerationErrorsIterator it)
XN_C_API XnStatus xnEnumerationErrorsGetCurrentError (XnEnumerationErrorsIterator it)

Detailed Description

This page details functions for managing an Enumeration Errors object.

Enumeration

The following code iterates over an enumeration errors object:

for (XnEnumerationErrorsIterator it = xnEnumerationErrorsGetFirst(pList); 
    xnEnumerationErrorsIteratorIsValid(it); 
    it = xnEnumerationErrorsGetNext(it))
{
    const XnProductionNodeDescription* pCurrDesc = xnEnumerationErrorsGetCurrentDescription(it);
    XnStatus nCurrError = xnEnumerationErrorsGetCurrentError(it);
    ...
}

Typedef Documentation

An object that holds errors during an enumeration process.

typedef struct XnModuleError* XnEnumerationErrorsIterator

Represents an iterator for an XnEnumerationErrors object.


Function Documentation

XN_C_API XnStatus xnEnumerationErrorsAdd ( XnEnumerationErrors pErrors,
const XnProductionNodeDescription pDesc,
XnStatus  nError 
)

Adds an error to the object.

Parameters:
pErrors [in] Enumeration Errors object.
pDesc [in] Description of the failing module.
nError [in] The enumeration error that occurred.
XN_C_API XnStatus xnEnumerationErrorsAllocate ( XnEnumerationErrors **  ppErrors  ) 

Allocates an enumeration errors object.

Parameters:
ppErrors [out] The allocated object
XN_C_API XnStatus xnEnumerationErrorsClear ( XnEnumerationErrors pErrors  ) 

Clears an Enumeration Errors object from all errors in it.

Parameters:
pErrors [in] Enumeration Errors object.
XN_C_API void xnEnumerationErrorsFree ( const XnEnumerationErrors pErrors  ) 

Frees an enumeration errors object

Parameters:
pErrors [in] Parameter description
XN_C_API const XnProductionNodeDescription* xnEnumerationErrorsGetCurrentDescription ( XnEnumerationErrorsIterator  it  ) 

Gets the description of the node from current error.

Parameters:
it [in] The iterator to the error.
XN_C_API XnStatus xnEnumerationErrorsGetCurrentError ( XnEnumerationErrorsIterator  it  ) 

Gets the enumeration error caused when enumerating the node.

Parameters:
it [in] The iterator to the error.
XN_C_API XnEnumerationErrorsIterator xnEnumerationErrorsGetFirst ( const XnEnumerationErrors pErrors  ) 

Gets an iterator to the first error in the object.

Parameters:
pErrors [in] Enumeration Errors object.
XN_C_API XnEnumerationErrorsIterator xnEnumerationErrorsGetNext ( XnEnumerationErrorsIterator  it  ) 

Gets an iterator to the next error in the object.

Parameters:
it [in] An iterator to an error in the object.
XN_C_API XnBool xnEnumerationErrorsIteratorIsValid ( XnEnumerationErrorsIterator  it  ) 

Checks if an iterator is valid (i.e. points to a real error)

Parameters:
it [in] The iterator to check.
XN_C_API XnStatus xnEnumerationErrorsToString ( const XnEnumerationErrors pErrors,
XnChar *  csBuffer,
XnUInt32  nSize 
)

Returns a string representation of the Enumeration Errors object.

Parameters:
pErrors [in] Enumeration Errors object.
csBuffer [in] A char buffer to be filled.
nSize [in] Size of the char buffer.