Message Functions (TipcMsg*)

The TipcMsg* functions are used to operate on messages. Typical operations include creating, cloning, and destroying messages, as well as constructing and accessing the fields in the data part of a message.

Construction Functions (TipcMsgAddNamed*)

The TipcMsgAdd* functions are used to write a field or fields into the data part of a message, referencing it by name.

TipcMsgAddNamedBinary — add a named BINARY field to a message 

T_BOOL TipcMsgAddNamedBinary(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_PTR value; 
T_INT4 size;

TipcMsgAddNamedBinaryPtr — add a named BINARY field to a message using a pointer 

T_BOOL TipcMsgAddNamedBinaryPtr(msg, name, ptr, size, field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_PTR ptr; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedBool — add a BOOL field to a message, referencing it by name 

T_BOOL TipcMsgAddNamedBool(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_BOOL value

TipcMsgAddNamedBoolArray — add a BOOL_ARRAY field to a message, referencing it by name 

T_BOOL TipcMsgAddNamedBoolArray(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_BOOL *value; 
T_INT4 size;

TipcMsgAddNamedBoolArrayPtr — add a named BOOL_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAddNamedBoolArrayPtr(msg, name, *value, size, 
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_BOOL *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedByte — add a BYTE field to a message, referencing it by name 

T_BOOL TipcMsgAddNamedByte(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_UCHAR value;

TipcMsgAddNamedChar — add a named CHAR field to a message 

T_BOOL TipcMsgAddNamedChar(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_CHAR value;

TipcMsgAddNamedInt2 — add a named INT2 field to a message 

T_BOOL TipcMsgAddNamedInt2(msg, name, value, field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT2 value; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedInt2Array — add a named INT2_ARRAY field to a message 

T_BOOL TipcMsgAddNamedInt2Array(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_INT2 *value; 
T_INT4 size;

TipcMsgAddNamedInt2ArrayPtr — add a named INT2_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAddNamedInt2ArrayPtr(msg, name, value, size, 
field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT2 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedInt4 — add a named INT4 field to a message 

T_BOOL TipcMsgAddNamedInt4(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_INT4 value;

TipcMsgAddNamedInt4Array — add a named INT4_ARRAY field to a message 

T_BOOL TipcMsgAddNamedInt4Array(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_INT4 *value; 
T_INT4 size;

TipcMsgAddNamedInt4ArrayPtr — add a named INT4_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAddNamedInt4ArrayPtr(msg, name, value, size, 
field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT4 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedInt8 — add a named INT8 field to a message 

T_BOOL TipcMsgAddNamedInt8(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_INT8 value;

TipcMsgAddNamedInt8Array — add a named INT8_ARRAY field to a message 

T_BOOL TipcMsgAddNamedInt8Array(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_INT8 *value; 
T_INT4 size;

TipcMsgAddNamedInt8ArrayPtr — add a named INT8_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAddNamedInt8ArrayPtr(msg, name, value, size, 
field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT8 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedMsg — add a named MSG field to a message 

T_BOOL TipcMsgAddNamedMsg(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_MSG value;=

TipcMsgAddNamedMsgArray — add a named MSG_ARRAY field to a message 

T_BOOL TipcMsgAddNamedMsgArray(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_MSG *value; 
T_INT4 size;

TipcMsgAddNamedMsgArrayPtr — add a named MSG_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAddNamedMsgArrayPtr(msg, name, value, size, 
field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_MSG *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedMsgPtr — add a MSG pointer field to a message, referencing it by name 

T_BOOL TipcMsgAddNamedStrPtr(msg, name, value, size, field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedReal4 — add a named REAL4 field to a message 

T_BOOL TipcMsgAddNamedReal4(msg, name, real4_data) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL4 real4_data;

TipcMsgAddNamedReal4Array — add a named REAL4_ARRAY field to a message 

T_BOOL TipcMsgAddNamedReal4Array(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL4 *value; 
T_INT4 size;

TipcMsgAddNamedReal4ArrayPtr — add a named REAL4_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAddNamedReal4ArrayPtr(msg, name, value, size, 
field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL4 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedReal8 — add a named REAL8 field to a message 

T_BOOL TipcMsgAddNamedReal8(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 value;

TipcMsgAddNamedReal8Array — add a named REAL8_ARRAY field to a message 

T_BOOL TipcMsgAddNamedReal8Array(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 *value; 
T_INT4 size;

TipcMsgAddNamedReal8ArrayPtr — add a named REAL8_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAddNamedReal8ArrayPtr(msg, name, value, size, 
field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedReal16 — add a named REAL16 field to a message 

T_BOOL TipcMsgAddNamedReal16(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL16 value;

TipcMsgAddNamedReal16Array — add a named REAL16_ARRAY field to a message 

T_BOOL TipcMsgAddNamedReal16Array(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL16 *value; 
T_INT4 size;

TipcMsgAddNamedReal16ArrayPtr — add a named REAL16_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAddNamedReal16ArrayPtr(msg, name, value, size, 
field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL16 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedStr — add a named STR field to a message 

T_BOOL TipcMsgAddNamedStr(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_STR value;

TipcMsgAddNamedStrArray — add a named STR_ARRAY field to a message 

T_BOOL TipcMsgAddNamedStrArray(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value; 
T_INT4 size;

TipcMsgAddNamedStrArrayPtr — add a named STR_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAddNamedStrArrayPtr(msg, name, value, size, 
field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedStrPtr — add a named STR field to a message using a pointer 

T_BOOL TipcMsgAddNamedStrPtr(msg, name, value, size, field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedTimestamp — add a TIMESTAMP field to a message using a name 

T_BOOL TipcMsgAddNamedTimestamp(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 value;

TipcMsgAddNamedTimestampArray — add a field containing an array of TIMESTAMP fields to a message using a name 

T_BOOL TipcMsgAddNamedTimestampArray(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 *value; 
T_INT4 size;

TipcMsgAddNamedTimestampArrayPtr — add a field containing an array of TIMESTAMP fields to a message using a name, and a pointer to the field value, rather than a copy 

T_BOOL TipcMsgAddNamedTimestampArrayPtr(msg, name, value, size, 
field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedUnknown — add a field with an unknown or non-existent value to a message using a name 

T_BOOL TipcMsgAddNamedUnknown(msg, name, type) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_FT type;

TipcMsgAddNamedUtf8 — add a UTF8 field to a message, referencing it by name 

T_BOOL TipcMsgAddNamedUtf8(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_STR value;

TipcMsgAddNamedUtf8Array — add a UTF8_ARRAY field to a message, referencing it by name 

T_BOOL TipcMsgAddNamedUtf8Array(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value; 
T_INT4 size;

TipcMsgAddNamedUtf8ArrayPtr — add a UTF8_ARRAY pointer field to a message, referencing it by name 

T_BOOL TipcMsgAddNamedUtf8ArrayPtr(msg, name, *value, size, 
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedUtf8Ptr — add a UTF8 pointer field to a message, referencing it by name 

T_BOOL TipcMsgAddNamedUtf8Ptr(msg, name, value, *field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR value; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAddNamedXml — add a named XML field to a message 

T_BOOL TipcMsgAddNamedXml(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_XML value;

TipcMsgAddNamedXmlPtr — add a named XML pointer field to a message 

T_BOOL TipcMsgAddNamedXmlPtr(msg, name, value, field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_XML value; 
T_IPC_MSG_FIELD *field_return;

Construction Functions (TipcMsgAppend*)

The TipcMsgAppend* functions are used to write a field or fields into the data part of a message.

TipcMsgAppendBinary — append a BINARY field to a message 

T_BOOL TipcMsgAppendBinary(msg, binary_data, binary_size) 
T_IPC_MSG msg; 
T_PTR binary_data; 
T_INT4 binary_size;

TipcMsgAppendBinaryPtr — append a BINARY field to a message using a pointer 

T_BOOL TipcMsgAppendBinaryPtr(msg, binary_data, binary_size, 
field_return) 
T_IPC_MSG msg; 
T_PTR binary_data; 
T_INT4 binary_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendBool — append a BOOL field to a message 

T_BOOL TipcMsgAppendBool(msg, bool_data) 
T_IPC_MSG msg; 
T_BOOL bool_data;

TipcMsgAppendBoolArray — append a field containing an array of BOOL fields to a message 

T_BOOL TipcMsgAppendBoolArray(msg, bool_array_data, array_size) 
T_IPC_MSG msg; 
T_BOOL *bool_array_data; 
T_INT4 array_size;

TipcMsgAppendBoolArrayPtr — append a field containing an array of BOOL fields to a message using a pointer 

T_BOOL TipcMsgAppendBoolArrayPtr(msg, bool_array_data, array_size, 
field_return) 
T_IPC_MSG msg; 
T_BOOL *bool_array_data; 
T_INT4 array_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendByte — append a BYTE field to a message 

T_BOOL TipcMsgAppendByte(msg, byte_data, byte_size) 
T_IPC_MSG msg; 
T_PTR byte_data; 
T_INT4 byte_size;

TipcMsgAppendChar — append a CHAR field to a message 

T_BOOL TipcMsgAppendChar(msg, char_data) 
T_IPC_MSG msg; 
T_CHAR char_data;

TipcMsgAppendInt2 — append an INT2 field to a message 

T_BOOL TipcMsgAppendInt2(msg, int2_data) 
T_IPC_MSG msg; 
T_INT2 int2_data;

TipcMsgAppendInt2Array — append an INT2_ARRAY field to a message 

T_BOOL TipcMsgAppendInt2Array(msg, int2_array_data, int2_array_size) 
T_IPC_MSG msg; 
T_INT2 *int2_array_data; 
T_INT4 int2_array_size;

TipcMsgAppendInt2ArrayPtr — append an INT2_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAppendInt2ArrayPtr(msg, int2_array_data, 
int2_array_size, field_return) 
T_IPC_MSG msg; 
T_INT2 *int2_array_data; 
T_INT4 int2_array_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendInt4 — append an INT4 field to a message 

T_BOOL TipcMsgAppendInt4(msg, int4_data) 
T_IPC_MSG msg; 
T_INT4 int4_data;

TipcMsgAppendInt4Array — append an INT4_ARRAY field to a message 

T_BOOL TipcMsgAppendInt4Array(msg, int4_array_data, int4_array_size) 
T_IPC_MSG msg; 
T_INT4 *int4_array_data; 
T_INT4 int4_array_size;

TipcMsgAppendInt4ArrayPtr — append an INT4_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAppendInt4ArrayPtr(msg, int4_array_data, 
int4_array_size, field_return) 
T_IPC_MSG msg; 
T_INT4 *int4_array_data; 
T_INT4 int4_array_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendInt8 — append an INT8 field to a message 

T_BOOL TipcMsgAppendInt8(msg, int8_data) 
T_IPC_MSG msg; 
T_INT8 int8_data;

TipcMsgAppendInt8Array — append an INT8_ARRAY field to a message 

T_BOOL TipcMsgAppendInt8Array(msg, int8_array_data, int8_array_size) 
T_IPC_MSG msg; 
T_INT8 *int8_array_data; 
T_INT4 int8_array_size;

TipcMsgAppendInt8ArrayPtr — append an INT8_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAppendInt8ArrayPtr(msg, int8_array_data, 
int8_array_size, field_return) 
T_IPC_MSG msg; 
T_INT8 *int8_array_data; 
T_INT4 int8_array_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendMsg — append a MSG field to a message 

T_BOOL TipcMsgAppendMsg(msg, msg_data) 
T_IPC_MSG msg; 
T_IPC_MSG msg_data;

TipcMsgAppendMsgArray — append a MSG_ARRAY field to a message 

T_BOOL TipcMsgAppendMsgArray(msg, msg_array_data, msg_array_size) 
T_IPC_MSG msg; 
T_IPC_MSG *msg_array_data; 
T_INT4 msg_array_size;

TipcMsgAppendMsgArrayPtr — append a MSG_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAppendMsgArrayPtr(msg, msg_array_data, 
msg_array_size, field_return) 
T_IPC_MSG msg; 
T_IPC_MSG *msg_array_data; 
T_INT4 msg_array_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendMsgPtr — append a MSG field to a message using a pointer 

T_BOOL TipcMsgAppendMsgPtr(msg, msg_data, field_return) 
T_IPC_MSG msg; 
T_IPC_MSG msg_data; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendReal4 — append a REAL4 field to a message 

T_BOOL TipcMsgAppendReal4(msg, real4_data) 
T_IPC_MSG msg; 
T_REAL4 real4_data;

TipcMsgAppendReal4Array — append a REAL4_ARRAY field to a message 

T_BOOL TipcMsgAppendReal4Array(msg, real4_array_data, 
real4_array_size) 
T_IPC_MSG msg; 
T_REAL4 *real4_array_data; 
T_INT4 real4_array_size;

TipcMsgAppendReal4ArrayPtr — append a REAL4_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAppendReal4ArrayPtr(msg, real4_array_data, 
real4_array_size, field_return) 
T_IPC_MSG msg; 
T_REAL4 *real4_array_data; 
T_INT4 real4_array_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendReal8 — append a REAL8 field to a message 

T_BOOL TipcMsgAppendReal8(msg, real8_data) 
T_IPC_MSG msg; 
T_REAL8 real8_data;

TipcMsgAppendReal8Array — append a REAL8_ARRAY field to a message 

T_BOOL TipcMsgAppendReal8Array(msg, real8_array_data, 
real8_array_size) 
T_IPC_MSG msg; 
T_REAL8 *real8_array_data; 
T_INT4 real8_array_size;

TipcMsgAppendReal8ArrayPtr — append a REAL8_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAppendReal8ArrayPtr(msg, real8_array_data, 
real8_array_size, field_return) 
T_IPC_MSG msg; 
T_REAL8 *real8_array_data; 
T_INT4 real8_array_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendReal16 — append a REAL16 field to a message 

T_BOOL TipcMsgAppendReal16(msg, real16_data) 
T_IPC_MSG msg; 
T_REAL16 real16_data;

TipcMsgAppendReal16Array — append a REAL16_ARRAY field to a message 

T_BOOL TipcMsgAppendReal16Array(msg, real16_array_data, 
real16_array_size) 
T_IPC_MSG msg; 
T_REAL16 *real16_array_data; 
T_INT4 real16_array_size;

TipcMsgAppendReal16ArrayPtr — append a REAL16_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAppendReal16ArrayPtr(msg, real16_array_data, 
real16_array_size, field_return) 
T_IPC_MSG msg; 
T_REAL16 *real16_array_data; 
T_INT4 real16_array_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendStr — append a STR field to a message 

T_BOOL TipcMsgAppendStr(msg, str_data) 
T_IPC_MSG msg; 
T_STR str_data;

TipcMsgAppendStrArray — append a STR_ARRAY field to a message 

T_BOOL TipcMsgAppendStrArray(msg, str_array_data, str_array_size) 
T_IPC_MSG msg; 
T_STR *str_array_data; 
T_INT4 str_array_size;

TipcMsgAppendStrArrayPtr — append a STR_ARRAY field to a message using a pointer 

T_BOOL TipcMsgAppendStrArrayPtr(msg, str_array_data, str_array_size,  
field_return) 
T_IPC_MSG msg; 
T_STR *str_array_data; 
T_INT4 str_array_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendStrPtr — append a STR field to a message using a pointer 

T_BOOL TipcMsgAppendStrPtr(msg, str_data, field_return) 
T_IPC_MSG msg; 
T_STR str_data; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendStrReal8 — append a STR field and a REAL8 field to a message 

T_BOOL TipcMsgAppendStrReal8(msg, str_data, real8_data) 
T_IPC_MSG msg; 
T_STR str_data; 
T_REAL8 real8_data;

TipcMsgAppendTimestamp — append a TIMESTAMP field to a message 

T_BOOL TipcMsgAppendTimestamp(msg, timestamp_data) 
T_IPC_MSG msg; 
T_REAL8 timestamp_data;

TipcMsgAppendTimestampArray — append a field containing an array of TIMESTAMP fields to a message 

T_BOOL TipcMsgAppendTimestampArray(msg, timestamp_array_data, 
array_size) 
T_IPC_MSG msg; 
T_REAL8 *timestamp_array_data; 
T_INT4 array_size;

TipcMsgAppendTimestampArrayPtr — use a pointer to append a field containing an array of TIMESTAMP fields to a message 

T_BOOL TipcMsgAppendTimestampArrayPtr(msg, timestamp_array_data, 
array_size, field_return) 
T_IPC_MSG msg; 
T_REAL8 *timestamp_array_data; 
T_INT4 array_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendUnknown— append a field with value marked unknown to a message 

T_BOOL TipcMsgAppendUnknown(msg, field_type) 
T_IPC_MSG msg; 
T_IPC_FT field_type;

TipcMsgAppendUtf8 — append a UTF8 field to a message 

T_BOOL TipcMsgAppendUtf8(msg, utf8_data) 
T_IPC_MSG msg; 
T_STR utf8_data;

TipcMsgAppendUtf8Array — append a field containing an array of UTF8 fields to a message 

T_BOOL TipcMsgAppendUtf8Array(msg, utf8_array_data, array_size) 
T_IPC_MSG msg; 
T_UTF8 *utf8_array_data; 
T_INT4 array_size;

TipcMsgAppendUtf8ArrayPtr — append a field containing an array of UTF8 fields to a message using a pointer 

T_BOOL TipcMsgAppendUtf8ArrayPtr(msg, utf8_array_data, array_size, 
field_return) 
T_IPC_MSG msg; 
T_UTF8 *utf8_array_data; 
T_INT4 array_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendUtf8Ptr — append a UTF8 field to a message using a pointer 

T_BOOL TipcMsgAppendUtf8Ptr(msg, utf8_data, utf8_size, field_return) 
T_IPC_MSG msg; 
T_PTR utf8_data; 
T_INT4 utf8_size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgAppendXml — append an XML field to the end of a message 

T_BOOL TipcMsgAppendXml(msg, xml_data) 
T_IPC_MSG msg; 
T_XML xml_data;

TipcMsgAppendXmlPtr — append an XML field to a message using a pointer 

T_BOOL TipcMsgAppendXmlPtr(msg, xml_data, field_return) 
T_IPC_MSG msg; 
T_XML xml_data; 
T_IPC_MSG_FIELD *field_return;

Update Functions (TipcMsgUpdateNamed*)

The TipcMsgUpdateNamed* functions are used to update a field or fields in the data part of a message, referencing it by name.

TipcMsgUpdateNamedBinary — update a named BINARY field in a message 

T_BOOL TipcMsgUpdateNamedBinary(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_PTR value; 
T_INT4 size;

TipcMsgUpdateNamedBinaryPtr — update a named BINARY field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedBinaryPtr(msg, name, value, size, 
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_PTR value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedBool — update a named BOOL field in a message with new data 

T_BOOL TipcMsgUpdateNamedBool(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_BOOL value;

TipcMsgUpdateNamedBoolArray — update a named BOOL_ARRAY field in a message with new data 

T_BOOL TipcMsgUpdateNamedBoolArray(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_BOOL *value; 
T_INT4 size;

TipcMsgUpdateNamedBoolArrayPtr — update a named BOOL_ARRAY field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedBoolArrayPtr(msg, name, *value, size,  
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_BOOL *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedByte — update a named BYTE field in a message with new data 

T_BOOL TipcMsgUpdateNamedByte(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_UCHAR value;

TipcMsgUpdateNamedChar — update a named CHAR field in a message 

T_BOOL TipcMsgUpdateNamedChar(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_CHAR value;

TipcMsgUpdateNamedInt2 — update a named INT2 field in a message 

T_BOOL TipcMsgUpdateNamedInt2(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_INT2 value;

TipcMsgUpdateNamedInt2Array — update a named INT2_ARRAY field in a message 

T_BOOL TipcMsgUpdateNamedInt2Array(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_INT2 *value; 
T_INT4 size;

TipcMsgUpdateNamedInt2ArrayPtr — update a named INT2_ARRAY field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedInt2ArrayPtr(msg, name, *value, size,  
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT2 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedInt4 — update a named INT4 field in a message 

T_BOOL TipcMsgUpdateNamedInt4(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_INT4 value;

TipcMsgUpdateNamedInt4Array — update a named INT4_ARRAY field in a message 

T_BOOL TipcMsgUpdateNamedInt4Array(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_INT4 *value; 
T_INT4 size;

TipcMsgUpdateNamedInt4ArrayPtr — update a named INT4_ARRAY field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedInt4ArrayPtr(msg, name, *value, size,  
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT4 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedInt8 — update a named INT8 field in a message 

T_BOOL TipcMsgUpdateNamedInt8(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_INT8 value;

TipcMsgUpdateNamedInt8Array — update a named INT8_ARRAY field in a message 

T_BOOL TipcMsgUpdateNamedInt8Array(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_INT8 *value; 
T_INT4 size;

TipcMsgUpdateNamedInt8ArrayPtr — update a named INT8_ARRAY field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedInt8ArrayPtr(msg, name, *value, size,  
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT8 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedMsg — update a named MSG field in a message 

T_BOOL TipcMsgUpdateNamedMsg(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_MSG value;

TipcMsgUpdateNamedMsgArray — update a named MSG_ARRAY field in a message 

T_BOOL TipcMsgUpdateNamedMsgArray(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_MSG *value; 
T_INT4 size;

TipcMsgUpdateNamedMsgArrayPtr — update a named MSG_ARRAY field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedMsgArrayPtr(msg, name, *value, size, 
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_MSG *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedMsgPtr — update a named MSG field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedMsgPtr(msg, name, value, *field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL4 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedReal4 — update a named REAL4 field in a message 

T_BOOL TipcMsgUpdateNamedReal4(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL4 value;

TipcMsgUpdateNamedReal4Array — update a named REAL4_ARRAY field in a message 

T_BOOL TipcMsgUpdateNamedReal4Array(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL4 *value; 
T_INT4 size;

TipcMsgUpdateNamedReal4ArrayPtr — update a named REAL4_ARRAY field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedReal4ArrayPtr(msg, name, *value, size, 
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL4 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedReal8 — update a named REAL8 field in a message 

T_BOOL TipcMsgUpdateNamedReal8(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 value;

TipcMsgUpdateNamedReal8Array — update a named REAL8_ARRAY field in a message 

T_BOOL TipcMsgUpdateNamedReal8Array(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 *value; 
T_INT4 size;

TipcMsgUpdateNamedReal8ArrayPtr — update a named REAL8_ARRAY field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedReal8ArrayPtr(msg, name, *value, size,  
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedReal16 — update a named REAL16 field in a message 

T_BOOL TipcMsgUpdateNamedReal16(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL16 value;

TipcMsgUpdateNamedReal16Array — update a named REAL16_ARRAY field in a message 

T_BOOL TipcMsgUpdateNamedReal16Array(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL16 *value; 
T_INT4 size;

TipcMsgUpdateNamedReal16ArrayPtr — update a named REAL16_ARRAY field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedReal16ArrayPtr(msg, name, *value, size, 
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL16 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedStrArray — update a named STR_ARRAY field in a message 

T_BOOL TipcMsgUpdateNamedStrArray(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value; 
T_INT4 size;

TipcMsgUpdateNamedStrArrayPtr — update a named STR_ARRAY field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedStrArrayPtr(msg, name, *value, size, 
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedStrPtr — update a named STR field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedStrPtr(msg, name, value, *field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR value; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedTimestamp — update a TIMESTAMP field in a message with new data 

T_BOOL TipcMsgUpdateNamedTimestamp(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 value;

TipcMsgUpdateNamedTimestampArray — update a field containing an array of TIMESTAMP fields in a message with new data 

T_BOOL TipcMsgUpdateNamedTimestampArray(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 *value; 
T_INT4 size;

TipcMsgUpdateNamedTimestampArrayPtr — update a pointer to the value of a named field containing an array of TIMESTAMP fields 

T_BOOL TipcMsgUpdateNamedTimestampArrayPtr(msg, name, value, 
size, field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedUtf8 — update a named UTF8 field in a message with new data 

T_BOOL TipcMsgUpdateNamedUtf8(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_STR value;

TipcMsgUpdateNamedUtf8Array — update a named UTF8_ARRAY field in a message with new data 

T_BOOL TipcMsgUpdateNamedUtf8Array(msg, name, *value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value; 
T_INT4 size;

TipcMsgUpdateNamedUtf8ArrayPtr — update a named UTF8_ARRAY field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedUtf8ArrayPtr(msg, name, *value, size, 
*field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedUtf8Ptr — update a named UTF8 field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedUtf8Ptr(msg, name, value, *field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR value; 
T_IPC_MSG_FIELD *field_return;

TipcMsgUpdateNamedXml — update a named XML field in a message 

T_BOOL TipcMsgUpdateNamedXml(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_XML value;

TipcMsgUpdateNamedXmlPtr — update a named XML field in a message using a pointer 

T_BOOL TipcMsgUpdateNamedXmlPtr(msg, name, value, *field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_XML value; 
T_IPC_MSG_FIELD *field_return;

Update Functions (TipcMsgFieldUpdate*)

The TipcMsgFieldUpdate* functions are used to update a field or fields in the data part of a message.

TipcMsgFieldUpdateBinaryPtr — update the pointer of the MSG field returned by TipcMsgAppendBinaryPtr 

T_BOOL TipcMsgFieldUpdateBinaryPtr(field, binary_data, array_size) 
T_IPC_MSG_FIELD field; 
T_PTR binary_data; 
T_INT4 array_size;

TipcMsgFieldUpdateBoolArrayPtr — update the pointer of the MSG field returned by TipcMsgAppendBoolArrayPtr 

T_BOOL TipcMsgFieldUpdateBoolArrayPtr(field, *bool_array, 
array_size) 
T_IPC_MSG_FIELD field; 
T_BOOL *bool_array; 
T_INT4 array_size;

TipcMsgFieldUpdateInt2ArrayPtr — update the pointer of the MSG field returned by TipcMsgAppendInt2ArrayPtr 

T_BOOL TipcMsgFieldUpdateInt2ArrayPtr(field, *int2_array, 
array_size) 
T_IPC_MSG_FIELD field; 
T_INT2 *int2_array; 
T_INT4 array_size;

TipcMsgFieldUpdateInt4ArrayPtr — update the pointer of the MSG field returned by TipcMsgAppendInt4ArrayPtr 

T_BOOL TipcMsgFieldUpdateInt4ArrayPtr(field, *int4_array, 
array_size) 
T_IPC_MSG_FIELD field; 
T_INT4 *int4_array; 
T_INT4 array_size;

TipcMsgFieldUpdateInt8ArrayPtr — update the pointer of the MSG field returned by TipcMsgAppendInt8ArrayPtr 

T_BOOL TipcMsgFieldUpdateInt8ArrayPtr(field, *int8_array, 
array_size) 
T_IPC_MSG_FIELD field; 
T_INT8 *int8_array; 
T_INT4 array_size;

TipcMsgFieldUpdateMsgArrayPtr — update the pointer of the MSG field returned by TipcMsgAppendMsgArrayPtr 

T_BOOL TipcMsgFieldUpdateMsgArrayPtr(field, *msg_array_data, 
array_size) 
T_IPC_MSG_FIELD field; 
T_MSG *msg_array_data; 
T_INT4 array_size;

TipcMsgFieldUpdateMsgPtr — update the pointer of the MSG field returned by TipcMsgAppendMsgPtr 

T_BOOL TipcMsgFieldUpdateMsgPtr(field, msg_data) 
T_IPC_MSG_FIELD field; 
T_MSG msg_data;

TipcMsgFieldUpdateReal4ArrayPtr — update the pointer of the MSG field returned by TipcMsgAppendReal4ArrayPtr 

T_BOOL TipcMsgFieldUpdateReal4ArrayPtr(field, *real4_array, 
array_size) 
T_IPC_MSG_FIELD field; 
T_REAL4 *real4_array; 
T_INT4 array_size;

TipcMsgFieldUpdateReal8ArrayPtr — update the pointer of the MSG field returned by TipcMsgAppendReal8ArrayPtr 

T_BOOL TipcMsgFieldUpdateReal8ArrayPtr(field, *real8_array, 
array_size) 
T_IPC_MSG_FIELD field; 
T_REAL8 *real8_array; 
T_INT4 array_size;

TipcMsgFieldUpdateReal16ArrayPtr — update the pointer of the MSG field returned by TipcMsgAppendReal16ArrayPtr 

T_BOOL TipcMsgFieldUpdateReal16ArrayPtr(field, *real16_array, 
array_size) 
T_IPC_MSG_FIELD field; 
T_REAL16 *real16_array; 
T_INT4 array_size;

TipcMsgFieldUpdateStrArrayPtr — update the pointer of the MSG field returned by TipcMsgAppendStrArrayPtr 

T_BOOL TipcMsgFieldUpdateStrArrayPtr(field, *str_array_data, 
array_size) 
T_IPC_MSG_FIELD field; 
T_STR *str_array_data; 
T_INT4 array_size;

TipcMsgFieldUpdateStrPtr — update the pointer of the MSG field returned by TipcMsgAppendStrPtr 

T_BOOL TipcMsgFieldUpdateStrPtr(field, str_data) 
T_IPC_MSG_FIELD field; 
T_STR str_data;

TipcMsgFieldUpdateTimestampArrayPtr — update the pointer of the message field returned by TipcMsgAppendTimestampArrayPtr 

T_BOOL TipcMsgFieldUpdateTimestampArrayPtr(field, 
*timestamp_array, array_size) 
T_IPC_MSG_FIELD field; 
T_REAL8 *timestamp_array; 
T_INT4 array_size;

TipcMsgFieldUpdateUtf8ArrayPtr — update the pointer of the MSG field returned by TipcMsgAppendUtf8ArrayPtr 

T_BOOL TipcMsgFieldUpdateUtf8ArrayPtr(field, *str_array_data, 
array_size) 
T_IPC_MSG_FIELD field; 
T_STR *str_array_data; 
T_INT4 array_size;

TipcMsgFieldUpdateUtf8Ptr — update the pointer of the MSG field returned by TipcMsgAppendUtf8Ptr 

T_BOOL TipcMsgFieldUpdateUtf8Ptr(field, str_data) 
T_IPC_MSG_FIELD field; 
T_STR str_data;

TipcMsgFieldUpdateXmlPtr — update the pointer of the MSG field returned by TipcMsgAppendXmlPtr 

T_BOOL TipcMsgFieldUpdateXmlPtr(field, xml_data) 
T_IPC_MSG_FIELD field; 
T_XML xml_data;

Create, Destroy and Clone Functions (TipcMsg*)

These functions are used to copy a message, create a new message of a specified type, and destroy a message.

TipcMsgClone — make an identical copy of a message 

T_IPC_MSG TipcMsgClone(msg) 
T_IPC_MSG msg;

TipcMsgCreate — create a new message 

T_IPC_MSG TipcMsgCreate(mt) 
T_IPC_MT mt;

TipcMsgDeleteCurrent — delete the current field from a message 

T_BOOL TipcMsgDeleteCurrent(msg) 
T_IPC_MSG msg;

TipcMsgDeleteField — delete a field, specified by field number, from a message 

T_BOOL TipcMsgDeleteField(msg, field_num) 
T_IPC_MSG msg; 
T_INT4 field_num;

TipcMsgDeleteNamedField — delete a field, specified by field name, from a message 

T_BOOL TipcMsgDeleteNamedField(msg, name) 
T_IPC_MSG msg; 
T_STR name;

TipcMsgDestroy — destroy a message 

T_BOOL TipcMsgDestroy(msg) 
T_IPC_MSG msg;

TipcMsgExistsNamed — determine if a field exists in a message, using a name 

T_BOOL TipcMsgExistsNamed(msg, name, exists) 
T_IPC_MSG msg; 
T_STR name; 
T_BOOL *exists;

File Functions (TipcMsgFile*)

The TipcMsgFile* functions are used to work with message files.

TipcMsgFileCreate — create a message file 

T_IPC_MSG_FILE TipcMsgFileCreate(file_name, create_mode) 
T_STR file_name; 
T_IPC_MSG_FILE_CREATE_MODE create_mode;

TipcMsgFileCreateFromFile — create a message file from an existing file 

T_IPC_MSG_FILE TipcMsgFileCreateFromFile(file, create_mode) 
FILE *file; 
T_IPC_MSG_FILE_CREATE_MODE create_mode;

TipcMsgFileDestroy — destroy a T_IPC_MSG_FILE 

T_BOOL TipcMsgFileDestroy(msg_file) 
T_IPC_MSG_FILE msg_file;

TipcMsgFileRead — read a message from a message file 

T_BOOL TipcMsgFileRead(msg_file, msg_return) 
T_IPC_MSG_FILE msg_file; 
T_IPC_MSG *msg_return;

TipcMsgFileWrite — write a message to a message file 

T_BOOL TipcMsgFileWrite(msg_file, msg) 
T_IPC_MSG_FILE msg_file; 
T_IPC_MSG msg;

Property Get Functions (TipcMsgGet*)

The TipcMsgGet* functions are used to retrieve the properties of a message. A property is a piece of information about a message, typically stored in the message header and the message data structure. They include items such as the destination of the message, message priority, and message type.

TipcMsgGetArrivalTimestamp — determine the arrival timestamp property of a message 

T_BOOL TipcMsgGetArrivalTimestamp(msg, arrival_timestamp_return) 
T_IPC_MSG msg; 
T_REAL8 *arrival_timestamp_return;

TipcMsgGetCompression — get the compression setting of a message 

T_BOOL TipcMsgGetCompression(msg, compress_return) 
T_IPC_MSG msg; 
T_BOOL *compress_return;

TipcMsgGetCorrelationId — determine the correlation identifier property of a message 

T_BOOL TipcMsgGetCorrelationId(msg, correlation_id_return) 
T_IPC_MSG msg; 
T_STR *correlation_id_return;

TipcMsgGetCurrent — determine the current field of a message 

T_BOOL TipcMsgGetCurrent(msg, field_num_return) 
T_IPC_MSG msg; 
T_INT4 *field_num_return;

TipcMsgGetCurrentFieldKnown — check if the current field of a message is of known value 

T_BOOL TipcMsgGetCurrentFieldKnown(msg, field_valid_return) 
T_IPC_MSG msg; 
T_BOOL *field_valid_return;

TipcMsgGetDeliveryMode — determine the delivery mode of a message 

T_BOOL TipcMsgGetDeliveryMode(msg, delivery_mode_return) 
T_IPC_MSG msg; 
T_IPC_DELIVERY_MODE *delivery_mode_return;

TipcMsgGetDeliveryTimeout — determine the delivery timeout property of a message 

T_BOOL TipcMsgGetDeliveryTimeout(msg, delivery_timeout_return) 
T_IPC_MSG msg; 
T_REAL8 *delivery_timeout_return;

TipcMsgGetDest — determine the destination property of a message 

T_BOOL TipcMsgGetDest(msg, dest_return) 
T_IPC_MSG msg; 
T_STR *dest_return;

TipcMsgGetExpiration — determine the expiration property of a message 

T_BOOL TipcMsgGetExpiration(msg, expiration_return) 
T_IPC_MSG msg; 
T_REAL8 *expiration_return;

TipcMsgGetHeaderStrEncode — determine the header string encode property of a message 

T_BOOL TipcMsgGetHeaderStrEncode(msg, header_str_encode_return) 
T_IPC_MSG msg; 
T_BOOL *header_str_encode_return;

TipcMsgGetLbMode — determine the load balancing mode of a message 

T_BOOL TipcMsgGetLbMode(msg, lb_mode_return) 
T_IPC_MSG msg; 
T_IPC_LB_MODE *lb_mode_return;

TipcMsgGetMessageId — determine the message identifier property of a message 

T_BOOL TipcMsgGetMessageId(msg, message_id_return) 
T_IPC_MSG msg; 
T_STR *message_id_return;

TipcMsgGetNumFields — determine the number of fields in a message 

T_BOOL TipcMsgGetNumFields(msg, num_fields_return) 
T_IPC_MSG msg; 
T_INT4 *num_fields_return;

TipcMsgGetPacketSize — determine the packet size of a message 

T_BOOL TipcMsgGetPacketSize(msg, packet_size_return) 
T_IPC_MSG msg; 
T_UINT4 *packet_size_return;

TipcMsgGetPriority — determine the priority of a message 

T_BOOL TipcMsgGetPriority(msg, priority_return) 
T_IPC_MSG msg;T_INT2 *priority_return;

TipcMsgGetReadOnly — get the read-only property of message 

T_BOOL TipcMsgGetReadOnly(msg, read_only_return) 
T_IPC_MSG msg; 
T_BOOL *read_only_return;

TipcMsgGetRefCount — determine the reference count of a message 

T_BOOL TipcMsgGetRefCount(msg, ref_count_return) 
T_IPC_MSG msg; 
T_INT4 *ref_count_return;

TipcMsgGetReplyTo — determine the reply to destination property of a message 

T_BOOL TipcMsgGetReplyTo(msg, reply_to_dest_return) 
T_IPC_MSG msg; 
T_STR *reply_to_dest_return;

TipcMsgGetSender — determine the sender property of a message 

T_BOOL TipcMsgGetSender(msg, sender_return) 
T_IPC_MSG msg; 
T_STR *sender_return;

TipcMsgGetSenderTimestamp — determine the sender timestamp property of a message 

T_BOOL TipcMsgGetSenderTimestamp(msg, sender_timestamp_return) 
T_IPC_MSG msg; 
T_REAL8 *sender_timestamp_return;

TipcMsgGetSeqNum — determine the sequence number of a message 

T_BOOL TipcMsgGetSeqNum(msg, seq_num_return) 
T_IPC_MSG msg; 
T_INT4 *seq_num_return;

TipcMsgGetType — determine the type of a message 

T_BOOL TipcMsgGetType(msg, mt_return) 
T_IPC_MSG msg; 
T_IPC_MT *mt_return;

TipcMsgGetTypeNamed — determine the type of a message using a name 

T_BOOL TipcMsgGetTypeNamed(msg, name, type) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_MT *type;

TipcMsgGetTypeNum — get the message type of a message as an integer 

T_BOOL TipcMsgGetTypeNum (msg, type_num_return) 
T_IPC_MSG msg; 
T_INT4 *type_num_return;

TipcMsgGetUserProp — determine the user-defined property of a message 

T_BOOL TipcMsgGetUserProp(msg, user_prop_return) 
T_IPC_MSG msg; 
T_INT4 *user_prop_return;

Property Set Functions (TipcMsgSet*)

The TipcMsgSet* functions are used to set the properties of a message. A property is a piece of information about a message, typically stored in the message header and the message data structure. They include items such as the destination of the message, message priority, and message type.

TipcMsgSetArrivalTimestamp — set the arrival timestamp property of a message 

T_BOOL TipcMsgSetArrivalTimestamp(msg, arrival_timestamp) 
T_IPC_MSG msg; 
T_REAL8 arrival_timestamp;

TipcMsgSetCompression — enable or disable message compression 

T_BOOL TipcMsgSetCompression(msg, compress) 
T_IPC_MSG msg; 
T_BOOL compress;

TipcMsgSetCorrelationId — set the correlation identifier property of a message 

T_BOOL TipcMsgSetCorrelationId(msg, correlation_id) 
T_IPC_MSG msg; 
T_STR correlation_id;

TipcMsgSetCurrent — set the current field of a message 

T_BOOL TipcMsgSetCurrent(msg, field_num) 
T_IPC_MSG msg; 
T_INT4 field_num;

TipcMsgSetDeliveryMode — set the delivery mode of a message 

T_BOOL TipcMsgSetDeliveryMode(msg, delivery_mode) 
T_IPC_MSG msg; 
T_IPC_DELIVERY_MODE delivery_mode;

TipcMsgSetDeliveryTimeout — set the delivery timeout property of a message 

T_BOOL TipcMsgSetDeliveryTimeout(msg, delivery_timeout) 
T_IPC_MSG msg; 
T_REAL8 delivery_timeout;

TipcMsgSetDest — set the destination of a message 

T_BOOL TipcMsgSetDest(msg, dest) 
T_IPC_MSG msg; 
T_STR dest;

TipcMsgSetExpiration — set the expiration property of a message 

T_BOOL TipcMsgSetExpiration(msg, expiration) 
T_IPC_MSG msg; 
T_REAL8 expiration;

TipcMsgSetHeaderStrEncode — set the header string encode property of a message 

T_BOOL TipcMsgSetHeaderStrEncode(msg, header_str_encode) 
T_IPC_MSG msg; 
T_BOOL header_str_encode;

TipcMsgSetLbMode — set the load balancing mode of a message 

T_BOOL TipcMsgSetLbMode(msg, lb_mode) 
T_IPC_MSG msg; 
T_IPC_LB_MODE lb_mode;

TipcMsgSetNameCurrent — set the name of the current field 

T_BOOL TipcMsgSetNameCurrent(msg, name) 
T_IPC_MSG msg; 
T_STR name;

TipcMsgSetNumFields — set the number of fields in a message 

T_BOOL TipcMsgSetNumFields(msg, num_fields) 
T_IPC_MSG msg; 
T_INT4 num_fields;

TipcMsgSetPriority — set the priority of a message 

T_BOOL TipcMsgSetPriority(msg, priority) 
T_IPC_MSG msg; 
T_INT2 priority;

TipcMsgSetReplyTo — set the reply to destination property of a message 

T_BOOL TipcMsgSetReplyTo(msg, reply_to_dest) 
T_IPC_MSG msg; 
T_STR reply_to_dest;

TipcMsgSetSender — set the sender of a message 

T_BOOL TipcMsgSetSender(msg, sender) 
T_IPC_MSG msg; 
T_STR sender;

TipcMsgSetSenderTimestamp — set the sender timestamp property of a message 

T_BOOL TipcMsgSetSenderTimestamp(msg, sender_timestamp) 
T_IPC_MSG msg; 
T_REAL8 sender_timestamp;

TipcMsgSetType — set the type of a message 

T_BOOL TipcMsgSetType(msg, mt) 
T_IPC_MSG msg; 
T_IPC_MT mt;

TipcMsgSetUserProp — set the user-defined property of a message 

T_BOOL TipcMsgSetUserProp(msg, user_prop) 
T_IPC_MSG msg; 
T_INT4 user_prop;

Access Functions (TipcMsgGetName*)

The TipcMsgGetName* functions are used to read a field or fields from the data part of a message using a name.

TipcMsgGetNameCurrent — determine the name of the current field 

T_BOOL TipcMsgGetNameCurrent(msg, name_return) 
T_IPC_MSG msg; 
T_STR *name_return;

TipcMsgGetNamedBinary — get a BINARY field from a message using a name 

T_BOOL TipcMsgGetNamedBinary(msg, name, value_return, size_return) 
T_IPC_MSG msg; 
T_STR name; 
T_PTR *value_return; 
T_INT4 *size_return;

TipcMsgGetNamedChar — get a CHAR field from a message using a name 

T_BOOL TipcMsgGetNamedChar(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_CHAR *value_return;

TipcMsgGetNamedInt2 — get an INT2 field from a message using a name 

T_BOOL TipcMsgGetNamedInt2(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT2 *value_return;

TipcMsgGetNamedInt2Array — get an INT2_ARRAY field from a message using a name 

T_BOOL TipcMsgGetNamedInt2Array(msg, name, value_return, 
size_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT2 **value_return; 
T_INT4 *size_return;

TipcMsgGetNamedInt4 — get an INT4 field from a message using a name 

T_BOOL TipcMsgGetNamedInt4(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT4 *value_return;

TipcMsgGetNamedInt4Array — get an INT4_ARRAY field from a message using a name 

T_BOOL TipcMsgGetNamedInt4Array(msg, name, value_return, 
size_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT4 **value_return; 
T_INT4 *size_return;

TipcMsgGetNamedInt8 — get an INT8 field from a message using a name 

T_BOOL TipcMsgGetNamedInt8(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT8 *value_return;

TipcMsgGetNamedInt8Array — get an INT8_ARRAY field from a message using a name 

T_BOOL TipcMsgGetNamedInt8Array(msg, name, value_return, 
size_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT8 **value_return; 
T_INT4 *size_return;

TipcMsgGetNamedMsg — get a MSG field from a message using a name 

T_BOOL TipcMsgGetNamedMsg(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_MSG *value_return;

TipcMsgGetNamedMsgArray — get a MSG_ARRAY field from a message using a name 

T_BOOL TipcMsgGetNamedMsgArray(msg, name, value_return, size_return) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_MSG **value_return; 
T_INT4 *size_return;

TipcMsgGetNamedReal4 — get a REAL4 field from a message using a name 

T_BOOL TipcMsgGetNamedReal4(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL4 *value_return;

TipcMsgGetNamedReal4Array — get a REAL4_ARRAY field from a message using a name 

T_BOOL TipcMsgGetNamedReal4Array(msg, name, value_return, 
size_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL4 **value_return; 
T_INT4 *size_return;

TipcMsgGetNamedReal8 — get a REAL8 field from a message using a name 

T_BOOL TipcMsgGetNamedReal8(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 *value_return;

TipcMsgGetNamedReal8Array — get a REAL8_ARRAY field from a message using a name 

T_BOOL TipcMsgGetNamedReal8Array(msg, name, value_return, 
size_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 **value_return; 
T_INT4 *_size_return;

TipcMsgGetNamedReal16 — get a REAL16 field from a message using a name 

T_BOOL TipcMsgGetNamedReal16(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL16 *value_return;

TipcMsgGetNamedReal16Array — get a REAL16_ARRAY field from a message using a name 

T_BOOL TipcMsgGetNamedReal16Array(msg, name, value_return, 
size_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL16 **value_return; 
T_INT4 *size_return;

TipcMsgGetNamedStr — get a STR field from a message using a name 

T_BOOL TipcMsgGetNamedStr(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value_return;

TipcMsgGetNamedStrArray — get a STR_ARRAY field from a message using a name 

T_BOOL TipcMsgGetNamedStrArray(msg, name, value_return, size_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR **value_return; 
T_INT4 *size_return;

TipcMsgGetNamedTimestamp — get a field with a TIMESTAMP value from a message, using a name 

T_BOOL TipcMsgGetNamedTimestamp(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 *value_return;

TipcMsgGetNamedTimestampArray — get a field containing an array of TIMESTAMP values from a message, using a name 

T_BOOL TipcMsgGetNamedTimestampArray(msg, name, value_return, 
size_return) 
T_IPC_MSG msg; 
T_STR name; 
T_REAL8 **value_return; 
T_INT4 *size_return;

TipcMsgGetNamedUnknown — determine whether the next named field of a message is of unknown value 

T_BOOL TipcMsgGetNamedUnknown(msg, name) 
T_IPC_MSG msg; 
T_STR name;

TipcMsgGetNamedXml — get an XML field from a message using a name 

T_BOOL TipcMsgGetNamedXml(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_XML *value_return;

Access Functions (TipcMsgNext*)

The TipcMsgNext* functions are used to read a field or fields from the data part of a message.

TipcMsgNextBinary — get a BINARY field from a message 

T_BOOL TipcMsgNextBinary(msg, binary_return, size_return) 
T_IPC_MSG msg; 
T_PTR *binary_return; 
T_INT4 *size_return;

TipcMsgNextBool — get a BOOL field from a message 

T_BOOL TipcMsgNextBool(msg, bool_return) 
T_IPC_MSG msg; 
T_BOOL *bool_return;

TipcMsgNextBoolArray — get a field containing an array of BOOL fields from a message 

T_BOOL TipcMsgNextBoolArray(msg, bool_array_return, array_size_return) 
T_IPC_MSG msg; 
T_BOOL **bool_array_return; 
T_INT4 *array_size_return;

TipcMsgNextByte — get a BYTE field from a message 

T_BOOL TipcMsgNextByte(msg, byte_return) 
T_IPC_MSG msg; 
T_BYTE *byte_return;

TipcMsgNextChar — get a CHAR field from a message 

T_BOOL TipcMsgNextChar(msg, char_return) 
T_IPC_MSG msg; 
T_CHAR *char_return;

TipcMsgNextInt2 — get an INT2 field from a message 

T_BOOL TipcMsgNextInt2(msg, int2_return) 
T_IPC_MSG msg; 
T_INT2 *int2_return;

TipcMsgNextInt2Array — get an INT2_ARRAY field from a message 

T_BOOL TipcMsgNextInt2Array(msg, int2_array_return, array_size_return) 
T_IPC_MSG msg; 
T_INT2 **int2_array_return; 
T_INT4 *array_size_return;

TipcMsgNextInt4 — get an INT4 field from a message 

T_BOOL TipcMsgNextInt4(msg, int4_return) 
T_IPC_MSG msg; 
T_INT4 *int4_return;

TipcMsgNextInt4Array — get an INT4_ARRAY field from a message 

T_BOOL TipcMsgNextInt4Array(msg, int4_array_return, array_size_return) 
T_IPC_MSG msg; 
T_INT4 **int4_array_return; 
T_INT4 *array_size_return;

TipcMsgNextInt8 — get an INT8 field from a message 

T_BOOL TipcMsgNextInt8(msg, int8_return) 
T_IPC_MSG msg; 
T_INT8 *int8_return;

TipcMsgNextInt8Array — get an INT8_ARRAY field from a message 

T_BOOL TipcMsgNextInt8Array(msg, int8_array_return, array_size_return) 
T_IPC_MSG msg; 
T_INT8 **int8_array_return; 
T_INT4 *array_size_return;

TipcMsgNextMsg — get a MSG field from a message 

T_BOOL TipcMsgNextMsg(msg, msg_return) 
T_IPC_MSG msg; 
T_IPC_MSG *msg_return;

TipcMsgNextMsgArray — get a MSG_ARRAY field from a message 

T_BOOL TipcMsgNextMsgArray(msg, msg_array_return, array_size_return) 
T_IPC_MSG msg; 
T_IPC_MSG **msg_array_return; 
T_INT4 *array_size_return;

TipcMsgNextReal4 — get a REAL4 field from a message 

T_BOOL TipcMsgNextReal4(msg, real4_return) 
T_IPC_MSG msg; 
T_REAL4 *real4_return;

TipcMsgNextReal4Array — get a REAL4_ARRAY field from a message 

T_BOOL TipcMsgNextReal4Array(msg, real4_array_return, 
array_size_return) 
T_IPC_MSG msg; 
T_REAL4 **real4_array_return; 
T_INT4 *array_size_return;

TipcMsgNextReal8 — get a REAL8 field from a message 

T_BOOL TipcMsgNextReal8(msg, real8_return) 
T_IPC_MSG msg; 
T_REAL8 *real8_return;

TipcMsgNextReal8Array — get a REAL8_ARRAY field from a message 

T_BOOL TipcMsgNextReal8Array(msg, real8_array_return, 
array_size_return) 
T_IPC_MSG msg; 
T_REAL8 **real8_array_return; 
T_INT4 *array_size_return;

TipcMsgNextReal16 — get a REAL16 field from a message 

T_BOOL TipcMsgNextReal16(msg, real16_return) 
T_IPC_MSG msg; 
T_REAL16 *real16_return;

TipcMsgNextReal16Array — get a REAL16_ARRAY field from a message 

T_BOOL TipcMsgNextReal16Array(msg, real16_array_return, 
array_size_return) 
T_IPC_MSG msg; 
T_REAL16 **real16_array_return; 
T_INT4 *array_size_return;

TipcMsgNextStr — get a STR field from a message 

T_BOOL TipcMsgNextStr(msg, str_return) 
T_IPC_MSG msg; 
T_STR *str_return;

TipcMsgNextStrArray — get a STR_ARRAY field from a message 

T_BOOL TipcMsgNextStrArray(msg, str_array_return, array_size_return) 
T_IPC_MSG msg; 
T_STR **str_array_return; 
T_INT4 *array_size_return;

TipcMsgNextStrReal8 — get a STR field and a REAL8 field from a message 

T_BOOL TipcMsgNextStrReal8(msg, str_return, real8_return) 
T_IPC_MSG msg; 
T_STR *str_return; 
T_REAL8 *real8_return;

TipcMsgNextTimestamp — get a TIMESTAMP field from a message 

T_BOOL TipcMsgNextTimestamp(msg, timestamp_return) 
T_IPC_MSG msg; 
T_REAL8 *timestamp_return;

TipcMsgNextTimestampArray — get a field containing an array of TIMESTAMP fields from a message 

T_BOOL TipcMsgNextTimestampArray(msg, timestamp_array_return, 
array_size_return) 
T_IPC_MSG msg; 
T_REAL8 **timestamp_array_return; 
T_INT4 *array_size_return;

TipcMsgNextType — determine the field type of the current field of a message 

T_BOOL TipcMsgNextType(msg, ft_return) 
T_IPC_MSG msg; 
T_IPC_FT *ft_return;

TipcMsgNextUnknown — check if the next field of a message is of unknown value 

T_BOOL TipcMsgNextUnknown(msg) 
T_IPC_MSG msg;

TipcMsgNextUtf8 — get a UTF8 field from a message 

T_BOOL TipcMsgNextUtf8(msg, utf8_return) 
T_IPC_MSG msg; 
T_UTF8 *utf8_return;

TipcMsgNextUtf8Array — get a field containing an array of UTF8 fields from a message 

T_BOOL TipcMsgNextUtf8Array(msg, utf8_array_return, array_size_return) 
T_IPC_MSG msg; 
T_UTF8 **utf8_array_return; 
T_INT4 *array_size_return;

TipcMsgNextXml — determine the next XML string from a message 

T_BOOL TipcMsgNextXml(msg, xml_return) 
T_IPC_MSG msg; 
T_XML xml_return;

Miscellaneous Functions

These functions do not fit with any of the other established categories.

TipcMsgAck — acknowledge delivery of a message 

T_BOOL TipcMsgAck(msg) 
T_IPC_MSG msg;

TipcMsgFieldSetSize — set the size of a message pointer field 

T_BOOL TipcMsgFieldSetSize(field, size) 
T_IPC_MSG_FIELD field; 
T_INT4 size;

TipcMsgGenerateMessageId — generate the message identifier property for the message 

T_BOOL TipcMsgGenerateMessageId(msg) 
T_IPC_MSG msg;

TipcMsgIncrRefCount — increment the reference count of a message 

T_BOOL TipcMsgIncrRefCount(msg) 
T_IPC_MSG msg;

TipcMsgPrint — print all information of a message in a portable, reproducible format 

T_BOOL TipcMsgPrint(msg, func) 
T_IPC_MSG msg; 
T_OUT_FUNC func;

TipcMsgPrintError — report an error about an unexpected message 

T_BOOL TipcMsgPrintError(msg) 
T_IPC_MSG msg;

TipcMsgRead — read zero or more fields from a message 

T_BOOL TipcMsgRead(msg, ...) 
T_IPC_MSG msg;

TipcMsgReadVa — read zero or more fields from a message (va_list version) 

T_BOOL TipcMsgReadVa(msg, var_arg_list) 
T_IPC_MSG msg; 
va_list var_arg_list;

TipcMsgTraverse — traverse all fields in a message 

T_PTR TipcMsgTraverse(msg, func, arg) 
T_IPC_MSG msg; 
T_IPC_MSG_TRAV_FUNC func; 
T_PTR arg;

TipcMsgWrite — append zero or more fields to a message 

T_BOOL TipcMsgWrite(msg, ...) 
T_IPC_MSG msg;

TipcMsgWriteVa — append zero or more fields to a message (va_list version) 

T_BOOL TipcMsgWriteVa(msg, var_arg_list) 
T_IPC_MSG msg; 
va_list var_arg_list;
TIBCO SmartSockets™ API Quick Reference
Software Release 6.8, July 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com