Update String

Convenience Method

Declaration

TibrvStatus updateString(
    const char*        fieldName,
    const char*    value,
    tibrv_u16          fieldId=0);

Purpose

Update a field containing a character string.

Remarks

This convenience method locates a field (by name or identifier) and updates its data.

The type of the existing field (within the message) and the type of the updating value must match. The length of the string can change.

Pointer data previously extracted from the field remain valid and unchanged until the message is destroyed; that is, even updating the field’s value does not invalidate pointer data. (See Pointer Snapshot.)

Parameter

Description

fieldName

Update a field with this name.

value

Update the message field to this value (which may be a literal or stored in a variable).

The method copies the new value into the existing field.

fieldId

Update the field with this identifier. Zero is a special value that signifies no field identifier. It is illegal to add a field that has both a NULL field name, and a non-zero field identifier.

See Also

Field Names and Field Identifiers