Classes | Typedefs | Functions | Variables

XnDump.h File Reference

#include "XnOS.h"

Go to the source code of this file.

Classes

struct  XnDump

Typedefs

typedef struct XnDump XnDump

Functions

XN_C_API XnStatus XN_C_DECL xnDumpSetMaskState (const XnChar *csMask, XnBool bEnabled)
XN_C_API XnBool XN_C_DECL xnLogIsDumpMaskEnabled (const XnChar *csDumpMask)
XN_C_API void XN_C_DECL xnDumpInit (XnDump *pDump, const XnChar *csDumpMask, const XnChar *csHeader, const XnChar *csFileNameFormat,...)
XN_C_API void XN_C_DECL xnDumpForceInit (XnDump *pDump, const XnChar *csHeader, const XnChar *csFileNameFormat,...)
XN_C_API void XN_C_DECL xnDumpClose (XnDump *pDump)
XN_C_API void XN_C_DECL xnDumpWriteBufferImpl (XnDump dump, const void *pBuffer, XnUInt32 nBufferSize)
void xnDumpWriteBuffer (XnDump dump, const void *pBuffer, XnUInt32 nBufferSize)
XN_C_API void XN_C_DECL xnDumpWriteStringImpl (XnDump dump, const XnChar *csFormat,...)
XN_C_API void XN_C_DECL xnDumpFlush (XnDump dump)

Variables

const XnDump XN_DUMP_CLOSED = { XN_INVALID_FILE_HANDLE }

Typedef Documentation

typedef struct XnDump XnDump

Function Documentation

XN_C_API void XN_C_DECL xnDumpClose ( XnDump pDump  ) 

This function closes a dump file (use it once file is no longer needed). You can later use xnDumpWriteString and xnDumpWriteBuffer to write to this file.

Parameters:
pDump [in] A pointer to an XnDump struct returned from a call to xnDumpInit.
XN_C_API void XN_C_DECL xnDumpFlush ( XnDump  dump  ) 

Flushes a dump to the disk.

Parameters:
dump [in] The dump to flush.
XN_C_API void XN_C_DECL xnDumpForceInit ( XnDump pDump,
const XnChar *  csHeader,
const XnChar *  csFileNameFormat,
  ... 
)

This function creates an XnDump object through which dumps can be written. This dump will be created anyway, and does not depend on log configuration.

Parameters:
pDump [in] A handle to the dump.
csHeader [in] A header line to be written to the file. When this param is NULL, file will be opened as a binary file. When param is not NULL, the string will be written to the file once it is open.
csFileNameFormat [in] Format of the name to give the file.
... [in] Arguments for the file name format string.
XN_C_API void XN_C_DECL xnDumpInit ( XnDump pDump,
const XnChar *  csDumpMask,
const XnChar *  csHeader,
const XnChar *  csFileNameFormat,
  ... 
)

This function creates an XnDump object through which dumps can be written. Dump will only be created if the mask is enabled.

Parameters:
pDump [in] A handle to the dump.
csDumpMask [in] The mask under which this dump should be written.
csHeader [in] A header line to be written to the file. When this param is NULL, file will be opened as a binary file. When param is not NULL, the string will be written to the file once it is open.
csFileNameFormat [in] Format of the name to give the file.
... [in] Arguments for the file name format string.
XN_C_API XnStatus XN_C_DECL xnDumpSetMaskState ( const XnChar *  csMask,
XnBool  bEnabled 
)

Configures if a specific dump mask is enabled.

Parameters:
csMask [in] The mask to set.
bEnabled [in] TRUE to enable this mask, FALSE otherwise.
void xnDumpWriteBuffer ( XnDump  dump,
const void *  pBuffer,
XnUInt32  nBufferSize 
) [inline]
XN_C_API void XN_C_DECL xnDumpWriteBufferImpl ( XnDump  dump,
const void *  pBuffer,
XnUInt32  nBufferSize 
)

Writes a buffer to the dump.

Parameters:
dump [in] The dump to write to.
pBuffer [in] A pointer to the buffer to write.
nBufferSize [in] The number of bytes to write from the buffer.
XN_C_API void XN_C_DECL xnDumpWriteStringImpl ( XnDump  dump,
const XnChar *  csFormat,
  ... 
)

Writes a formatted string to the dump.

Parameters:
dump [in] The dump to write to.
csFormat [in] A format string.
... [in] Arguments to the format string.
XN_C_API XnBool XN_C_DECL xnLogIsDumpMaskEnabled ( const XnChar *  csDumpMask  ) 

This function checks if a dump mask is enabled

Parameters:
csDumpMask [in] The mask that should be checked.

Variable Documentation

const XnDump XN_DUMP_CLOSED = { XN_INVALID_FILE_HANDLE }