Open topic with navigation

TIBCO Rendezvous® 8.8.0

# tibrvMsg_GetFieldByIndex()

Function

## Declaration

    tibrv_status tibrvMsg_GetFieldByIndex(
        tibrvMsg             message,
        tibrvMsgField*       field,
        tibrv_u32            fieldIndex);

## Purpose

Get a field from a message by an index.

## Remarks

Programs can loop through all the fields of a message, to retrieve each field in turn using an integer index.

The function copies scalar data into the program’s field struct. Pointer data extracted from the field remain valid until the message is destroyed; that is, even removing the field or updating the field’s value does not invalidate pointer data.

Add, remove and update calls can perturb the order of fields (which, in turn, affects the results when a program gets a field by index).

Parameter | Description
`message` | Get the field from this message.
`field` | The program supplies a pointer to a tibrvMsgField struct; the function overwrites the contents of the struct, using information from the message field.
`fieldIndex` | Get the field with this index. Zero specifies the first field.

## See Also

tibrvMsg_GetField()

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO Rendezvous®

Copyright © 1997-2025. Cloud Software Group, Inc. All Rights Reserved.