TipcMsgSetHeaderStrEncode

Name

TipcMsgSetHeaderStrEncode — set the header string encode property of a message

Synopsis

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

Arguments

msg — message to set header string encode property for

header_str_encode — message header string encode property

Return Values

TRUE if the header string encode property was successfully set for the message, FALSE otherwise.

Diagnostics

If TipcMsgSetHeaderStrEncode fails, it returns FALSE and sets the global SmartSockets error number to one of:

T_ERR_NULL_PTR — msg was null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_READ_ONLY — the message was marked read-only. This happens if the message is a field in another message.

T_ERR_VAL_INVALID — header_str_encode was not TRUE or FALSE

Description

TipcMsgSetHeaderStrEncode sets the header string encode property of a message. The header string encode property of a message controls whether the message header string properties are converted into four-byte integers when the message is sent through a connection with TipcConnMsgSend. TipcMsgSetHeaderStrEncode overwrites the default value of the header string encode property set by TipcMtSetHeaderStrEncode. See TipcMsgGetHeaderStrEncode for more information on the message header string encode property.

Caution

None

Examples

This example enables the header string encoding property of a message:

if (!TipcMsgSetHeaderStrEncode(msg, TRUE)) { 
  return;  /* error */ 
}