MQPropertiesKeyIterationGetNext

The MQPropertiesKeyIterationGetNext function passes back the address of the next property key in the referenced properties handle.

MQPropertiesKeyIterationGetNext
											(const MQPropertiesHandle propertiesHandle,
                        ConstMQString * key);

Return Value

MQStatus. See the MQStatusIsError() function for more information.

Parameters

propertiesHandle

A properties handle whose contents you want to access.

key

The output parameter for the next properties key in the iteration. You should not attempt to modify or free it.

To Get Message Properties

1. Start the process by calling the MQPropertiesKeyIterationStart() function.

2. Loop using the MQPropertiesKeyIterationHasNext() function.

3. Extract the name of each property key by calling the MQPropertiesKeyIterationGetNext() function.

4. Determine the type of the property value for a given key by calling the MQGetPropertyType() function.

5. Use the appropriate MQGet...Property function to find the property value for the specified property key.

   If you know the property key, you can just use the appropriate MQGet...Property function to access its value.

   You should not modify or free the property key that is passed back to you by this function. Note that this function is not multi-thread-safe.