Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
virtual P6R::P6ERR P6R::p6ITTLVDumper::dumpTTLV ( P6UINT8 *  pTTLV,
P6SIZE  cTTLV,
P6TTLVDUMPFLAGS  fFlags,
P6UINT32  nRecord,
const P6WCHAR *  pszPrefix,
P6TTLVOUTCB  pfnOutput,
P6VOID *  pCBCtx 
)
pure virtual

Dumps the TTLV encoded data to the provide output function in text for use in debugging. 

Parameters

  

    
pTTLV[ in ] A pointer to a byte buffer containing the TTLV encoded data to dump. 

    
cTTLV[ in ] An integer specifying the valid number of bytes contained in the buffer pointed to by pTTLV. 

    
fFlags[ in ] Control flags that can be OR'd together allowing the caller to specify behavior of the dump method.
    

  • P6TTDF_HDRSONLY Dump only TTLV header information. The default dumps both headers and a Hex dump of the records data payload if any. Cannot be used in combination with P6TTDF_DATAONLY;
    • 

  • P6TTDF_DATAONLY (only valid in combination with P6TTDF_DUMPRECNUM). Cause only the payload of record specified in nRecord to be dumped. Cannot be used in combination with P6TTDF_HDRSONLY;
    • 

  • P6TTDF_DUMPRECNUM Limits the dump to only the record specified in the nRecord argument. If not specified, then nRecord is ignored. 
    • 




    
nRecord[ in ] Specified the zero relative record number of the record to be dumped if P6TTDF_DUMPRECNUM is specified in fFlags. Otherwise this argument is ignored. 

    
pszPrefix[ in ] A pointer to a NULL terminated string containing text that will prefix each line that output or NULL if no prefix is desired. 

    
pfnOutput[ in ] The address of a function defined as P6TTLVOUTCB which the dump method will call to output the dump data. 

    
pCtx[ in ] A user defined context value that will be passed to the pfnOutput output function whenever it is called.