Skip to main content
Version: 9.0.2

gr_application_get_data

#include <gre/gre.h>

int gr_application_get_data(
gr_application_t *app,
const char *key,
gr_data_format_t *fmt,
gr_wrapped_data_t *data
);

The gr_application_get_data function provides an interface to get Storyboard data variables associated with a key, and their formats.

gr_application_get_data function retrieves the data values and formats for any keys associated Storyboard engine variables.

The returned gr_wrapped_data_t must be freed with gr_application_free_data.

Parameters

ParameterTypeDescription
appgr_application_t*A pointer to an application handle created using gr_application_create_args.
keyconst char*The data key variable to get.
fmtconst char*The format describing the format you want the data in:
GR_DATA_FORMAT_(1s0, 1u1, 1s1, 2u1, ...),
"1s0" (string),
"4u1" (uint32_t),
"4s1" (int32_t)...
Can be NULL (data key format used)
datagr_data_union_t*Location to store the returned data, this is a copy of the requested data and its format Returns: Zero on success, -1 on failure.

Returns

TypeDescription
intZero on success, -1 on failure.