TipcMsgSetType

Name

TipcMsgSetType — set the type of a message

Synopsis

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

Arguments

msg — message to set type for

mt — message type

Return Values

TRUE if the type was successfully set for the message, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — msg was null or mt 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.

Description

TipcMsgSetType sets the type of a message. The type identifies the category of message being manipulated. Most connection callback types use a message type to allow various kinds of execution based on specific message types.

Caution

None

Examples

This example sets the type of a message to NUMERIC_DATA:

mt = TipcMtLookupByNum(T_MT_NUMERIC_DATA); 
if (mt == NULL) { 
  return;  /* error */ 
}  
 
if (!TipcMsgSetType(msg, mt)) { 
  return;  /* error */ 
}