TipcBufMsgNext

Name

TipcBufMsgNext — get a message from a T_BUF object

Synopsis

T_IPC_MSG TipcBufMsgNext(buf) 
T_BUF buf;

Arguments

buf — buffer holding the message

Return Values

The retrieved message, or NULL if there is an error.

Diagnostics

If TipcBufMsgNext fails, it returns NULL, and sets the global error number to one of:

T_ERR_NULL_PTR — buf was null.

T_ERR_MSG_CORRUPT — the binary large object block cannot be converted into a message.

T_ERR_VAL_TOO_SMALL — the buffer does not contain a complete message.

Description

Retrieves a message from a T_BUF object. The message must have been previously appended to that buffer with TipcBufMsgAppend.

Caution

This function is only necessary under unusual circumstances, such as when storing a complete SmartSockets message in a database, rather than the contents of the message.

Examples

This example pulls a message from a T_BUF object:

T_IPC_MSG msg; 
 
msg = TipcBufMsgNext(buf); 
if (msg == NULL) { 
  return;  /* error */ 
}