TipcMsgAppendUtf8

T_BOOL TipcMsgAppendUtf8(msg, utf8_data) 
T_IPC_MSG msg; 
T_STR utf8_data;

Arguments

Return Values

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

Diagnostics

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

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

Description

TipcMsgAppendStr appends a UTF8 field containing utf8_data to the end of a message’s data. TipcMsgAppendUtf8 makes a copy of the UTF8 data.

Caution

See Also

Examples

T_IPC_MSG mt; 
T_IPC_MSG msg; 
 
#define USER_MT_UTF8_TEST 100 
mt = TipcMtCreate("utf8_test", USER_MT_UTF8_TEST,  
                  "utf8"); 
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. */ 
 
if (!TipcMsgAppendUtf8(msg, "test")) { 
  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. */