cniBufferSize

Gets the size of the data buffer associated with (and owned by) the message object specified in the message argument.

Syntax

CciSize cniBufferSize(
  int*         returnCode,
  CciMessage*  message);

Parameters

returnCode
The return code from the function (output).
message
The address of the message object for which the size of the data buffer is to be returned (input).

Return values

The size of the buffer in bytes, or zero if no buffer exists. If an error occurred, (CCI_FAILURE) is returned, and the returnCode parameter indicates the reason for the error.

Related concepts
User-defined Input nodes
User-defined message processing nodes
User-defined output nodes

Related tasks
Creating an input node in C
Creating a message processing node in C

Related reference
C language node utility functions
cniBufferByte
cniBufferPointer
cniSetInputBuffer
cniWriteBuffer