TipcMtGetHeaderStrEncode

Name

TipcMtGetHeaderStrEncode — get the header string encode property of a message type

Synopsis

T_BOOL TipcMtGetHeaderStrEncode(mt, header_str_encode_return) 
T_IPC_MT mt; 
T_BOOL *header_str_encode_return; 

Arguments

mt — message type to get header string encode property from

header_str_encode_return — storage for message type header string encode property

Return Values

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

Diagnostics

If TipcMtGetHeaderStrEncode fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcMtGetHeaderStrEncode gets the header string encode property of a message type. 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. The header string encode property of a message type is used as the default header string encode property for messages of this type. When a message is created, its header string encode property is initialized to the message type header string encode property. See TipcMsgGetHeaderStrEncode for more information on the message header string encode property.

The header string encode property of an outgoing message can always be set on a per-message basis, but using the message type header string encode property makes it easier to change the default header string encode property for all outgoing messages of a specific type. The standard SmartSockets message types by default all have a header string encode property of FALSE, but these can be changed. User-defined message types can also use whatever header string encode property is appropriate.

Caution

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

See Also

TipcMtGetHeaderStrEncode, TipcMtSetHeaderStrEncode

Examples

This example prints the header string encode property of the NUMERIC_DATA message type:

T_IPC_MT mt; 
T_BOOL header_str_encode; 
 
mt = TipcMtLookup("numeric_data"); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
if (!TipcMtGetHeaderStrEncode(mt, &header_str_encode)) { 
  return;  /* error */ 
} 
 
TutOut("NUMERIC_DATA msg type has header string encode property 
%s\n",  
       header_str_encode ? "TRUE" : "FALSE");