MQeFieldsDumpLength

Description
Returns the total number of bytes that are used to hold the fields in this MQeFields object. The application programmer can use this number to allocate a memory chunk to hold all the fields.This API is used in conjunction with MQeFieldsDump().

Syntax
#include <hmq.h>
MQEINT32 MQeFieldsDumpLength( MQEHSESS hSess,
											MQEHFIELDS hFlds, 
               						MQEINT32 * pCompCode, 
											MQEINT32 * pReason) 

Parameters

MQEHSESS hSess - input
The session handle, returned by MQeInitialize.

MQEHFIELDS Flds - input
The handle to an MQeFields object.

MQEINT32 * pCompCode - output
MQECC_OK, MQECC_WARNING or MQECC_ERROR.

MQEINT32 * pReason - output
If the returned *pCompCode equals MQECC_ERROR, *pReason may have any of the following values::

MQE_EXCEPT_INVALID_HANDLE

Return Value

MQEINT32
  • On success, returns the number of bytes used to hold the field object data.
  • On failure, returns '-1'.

Example
See example in MQeFieldsDump.

See Also



© IBM Corporation 2002. All Rights Reserved