TipcMsgGetHeaderStrEncode

Name

TipcMsgGetHeaderStrEncode — get the header string encode property of a message

Synopsis

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

Arguments

msg — message to get header string encode property from

header_str_encode_return — storage for message header string encode property

Return Values

TRUE if the header string encode property was successfully retrieved from the message, FALSE otherwise.

Diagnostics

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

Description

TipcMsgGetHeaderStrEncode gets the header string encode property of a message, which controls whether the message header string properties are converted into four-byte integers when the message is sent through a connection with TipcConnMsgSend. Enabling this property compresses the message header so that less network bandwidth is used, but this compression requires more CPU utilization.

When a message is created, its header string encode property is initialized to the message type header string encode property. This allows a default value to easily be set for all messages of a certain type. See TipcMtGetHeaderStrEncode for more information on the message type header string encode property.

Caution

If TipcMsgGetHeaderStrEncode returns FALSE, it does not store a value in header_str_encode_return.

See Also

TipcMsgSetHeaderStrEncode, TipcMtGetHeaderStrEncode

Examples

This example prints the header string encode property of a message:

T_BOOL header_str_encode; 
if (!TipcMsgGetHeaderStrEncode(msg, &header_str_encode)) { 
  return;  /* error */ 
} 
TutOut("The message %s encoding header strings.\n", 
       header_str_encode ? "is" : "is not");