cniBufferByte

Use this function to get a single byte from the data buffer associated with (and owned by) the message object specified in the message argument. The value of the index argument indicates which byte in the byte array is to be returned.

Syntax

CciByte cniBufferByte(
  int*         returnCode,
  CciMessage*  message,
  CciSize      index);

Parameters

returnCode

The return code from the function (output).

Possible return codes are:

CCI_SUCCESS
CCI_EXCEPTION
CCI_INV_MESSAGE_OBJECT

message

The address of the message object for which the size of the data buffer is to be returned (input).

index

The offset to use as an index into the buffer (input).

Return values

The requested byte is returned. If an error occurred, the returnCode parameter indicates the reason for the error.