TipcMtSetHeaderStrEncode

Name

TipcMtSetHeaderStrEncode — set the header string encode property of a message type

Synopsis

T_BOOL TipcMtSetHeaderStrEncode(mt, header_str_encode) 
T_IPC_MT mt; 
T_BOOL header_str_encode; 

Arguments

mt — message type to set header string encode property for

header_str_encode — message type header string encode property

Return Values

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

Diagnostics

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

Description

TipcMtSetHeaderStrEncode sets the header string encode property of a message type. The header string encode property of a message type is used as the default header string encode property for messages of this type. See TipcMtGetHeaderStrEncode for more information on the message type header string encode property.

Caution

None

See Also

TipcMsgSetHeaderStrEncode, TipcMtGetHeaderStrEncode

Examples

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

T_IPC_MT mt; 
 
mt = TipcMtLookup("numeric_data"); 
if (mt == NULL) { 
  return;  /* error */ 
} 
if (!TipcMtSetHeaderStrEncode(mt, TRUE)) { 
  return;  /* error */ 
} 
/* After this point, all newly-created NUMERIC_DATA messages will have a default header string 
encode property of TRUE. */