TipcMsgDeleteNamedField

Name

TipcMsgDeleteNamedField — delete a field, specified by field name, from a message

Synopsis

T_BOOL TipcMsgDeleteNamedField(msg, name) 
T_IPC_MSG msg; 
T_STR name;

Arguments

msg — message to delete field from

name — name of the field to delete

Return Values

TRUE if the deletion was successful, FALSE otherwise.

Diagnostics

If TipcMsgDeleteNamedField fails, it returns FALSE and sets the global SmartSockets error numbers to one of the following:

T_ERR_NULL_PTR — msg 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

TipcMsgDeleteNamedField deletes the named field from the message. The index positions associated with the subsequent named fields are updated. If no such field exists, the function returns FALSE.

Examples

This example deletes the named field "cost":

if (!TipcMsgDeleteNamedField(msg, "cost")) { 
 return;  /* error */