TipcMsgDeleteField

Name

TipcMsgDeleteField — delete a field, specified by field number, from a message

Synopsis

T_BOOL TipcMsgDeleteField(msg, field_num) 
T_IPC_MSG msg; 
T_INT4 field_num;

Arguments

msg — message to delete field from

field_num — number of the field

Return Values

TRUE if the deletion was successful, FALSE otherwise.

Diagnostics

If TipcMsgDeleteField 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

TipcMsgDeleteField deletes the field of the specified number from the message, irrespective of whether the field is named or unnamed, and updates the field numbers of the subsequent fields. (For example, if field 3 is deleted, field 4 becomes field 3, field 5 becomes field 4, and so on.) If no such field exists, the function returns FALSE.

Examples

This code example deletes the field of the specified number from the message:

if (!TipcMsgDeleteField(msg, field_num)) { 
  return;  /* error */ 
}