push_payload_get_header()

Get the push header at the specified index from a push_payload_t structure.

Synopsis:

#include <bbpush/push_payload.h>
 
const push_header_t* push_payload_get_header(const push_payload_t *push_payload, int index)

Since:

BlackBerry 10.2.0

Arguments:

push_payload

A pointer to the push_payload_t structure whose push_header_t member you want to retrieve.

index

The index of the push_header_t member you want to retrieve.

Library:

libPushService

Description:

The push_payload_get_header() function extracts the push header at the specified index of a given push_payload_t structure.

To access the header name and value, use the push_header_get_name() and push_header_get_value() functions.

This function doesn't copy members, and the returned values are released once the push_payload_t structure is destroyed with the push_payload_destroy() function.

Returns:

A pointer to the push header at the specified index.

Last modified: 2013-12-21

comments powered by Disqus