TipcMsgAppendMsg

TRUE if the field was successfully appended to the message, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — msg was null or msg_data was null

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

T_ERR_MSG_INVALID — msg was not a valid message or msg_data was not a valid message

T_ERR_VAL_INVALID — msg_data and msg were the same message (a message cannot be appended to itself)

Description

TipcMsgAppendMsg appends a MSG field containing msg_data to the end of a message’s data. TipcMsgAppendMsg makes a copy of the message data.

Caution

See Also

Examples

T_IPC_MSG msg; 
T_IPC_MSG msg_data; 
 
#define USER_MT_CONTAINER 100 
 
mt = TipcMtCreate("container", USER_MT_CONTAINER, "msg"); 
if (mt == NULL) { 
  return;  /* error */ 
}  
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
  return;  /* error */ 
}  
 
/* An RTclient would typically set the destination of */ 
/* a message at this point by calling TipcMsgSetDest. */ 
 
mt = TipcMtLookupByNum(T_MT_NUMERIC_DATA); 
if (mt == NULL) { 
  return;  /* error */ 
}  
msg_data = TipcMsgCreate(mt); 
if (msg_data == NULL) { 
  return;  /* error */ 
}  
 
if (!TipcMsgAppendStrReal8(msg_data, "speed_limit", 55.0)) { 
  return;  /* error */ 
}  
 
if (!TipcMsgAppendMsg(msg, msg_data)) { 
  return;  /* error */ 
}  
 
/* A process would typically send a message at this point by */ 
/* calling TipcConnMsgSend or TipcSrvMsgSend. */ 
 
/* A process would typically destroy a message at this point by */ 
/* calling TipcMsgDestroy. */