cniBufferByte

Gets 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).
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.

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
cniBufferPointer
cniBufferSize
cniSetInputBuffer
cniWriteBuffer