TipcMsgFieldUpdateStrPtr

Name

TipcMsgFieldUpdateStrPtr — update the pointer of the message field returned by TipcMsgAppendStrPtr

Synopsis

T_BOOL TipcMsgFieldUpdateStrPtr(field, str_data) 
T_IPC_MSG_FIELD field; 
T_STR str_data;

Arguments

field — message pointer field to update

str_data — data for new message field

Return Values

TRUE if the pointer was successfully updated, FALSE otherwise.

Diagnostics

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

T_ERR_FT_MISMATCH — the message type grammar did not match the fields in the message

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

Description

TipcMsgFieldUpdateStrPtr updates the pointer of the message field returned by TipcMsgAppendStrPtr. The contents of the pointer are not copied. Instead, the supplied pointer is entered directly into the message field's internal data structure. The caller is responsible for making sure that the pointer remains valid for the lifetime of the message field, and for freeing it, if necessary, when the message field has been destroyed.

Examples

This example changes the pointer of the STR field:

T_STR ptr1, ptr2; 
T_INT4 size1, size2; 
T_IPC_MSG_FIELD field; 
 
if (!TipcMsgAppendStrPtr(msg, ptr1, size1, &field)) { 
  return;  /* error */ 
} 
 
if (!TipcMsgFieldUpdateStrPtr(field, ptr2, size2)) { 
  return;  /* error */ 
}