push_payload_create()

Create a push_payload_t structure and allocate all necessary memory.

Synopsis:

#include <bbpush/push_payload.h>

int push_payload_create(push_payload_t **push_payload)

Since:

BlackBerry 10.2.0

Arguments:

push_payload: The push_payload_t structure to populate.

Library:

libPushService (For the qcc command, use the -l PushService option to link against this library)

Description:

The push_payload_create() function creates an instance of a push_payload_t structure called push_payload to be used to store the push content received from the Push Proxy Gateway (PPG).

Use the push_payload_destroy() function to deallocate memory used by a push_payload_t structure (created by the push_payload_create() function) that's no longer in use. Failing to do so will result in a memory leak.

Returns:

PUSH_SUCCESS upon success, PUSH_FAILURE with errno set otherwise.