tibrvMsg_RemoveFieldInstance()

Function

Declaration

tibrv_status tibrvMsg_RemoveFieldInstance(
    tibrvMsg         message,
    const char*      fieldName,
    tibrv_u32        instance);

Purpose

Remove a specified instance of a field from a message.

Remarks

When a message contains several field instances with the same field name, remove a specific instance by number (for example, remove the ith field named foo). Programs can use this function in a loop that examines every field with a specified name.

The argument 1 denotes the first instance of the named field.

If the specified instance does not exist, the function returns TIBRV_NOT_FOUND.

Pointer data (such as strings, arrays, submessages, opaque byte sequences or XML data) previously extracted from the field remains valid even after removing the field from the message.

Parameter	Description
message	Remove the specified field from this message.
fieldName	Remove the field with this name.
instance	Remove this instance of the field. The argument 1 specifies the first instance of the named field.

See Also

tibrvMsg_RemoveField()