PtAppGetResource()

Retrieve one resource value for an application

Synopsis:

#define PtAppGetResources(type, value, len)

Arguments:

type
The resource manifest (E.G Pt_CB_APP_EXIT).
value
The address of a pointer to the appropriate data type (see the “New resources” tables in the Photon Widget Reference).
len
Depends on the resource type.

Library:

ph

Description:

This macro sets a pointer to a resource value within the application.

PtAppGetResource() doesn't support the nonpointer method of getting resources. For more information, see the Manipulating Resources in Application Code chapter of the Photon Programmer's Guide. For a list of application callbacks, see PtAppSetResources().


WARNING: Because PtAppGetResource() returns pointers directly into the internals of the widget, don't modify those values directly. If you wish to retrieve the value of a given resource and then modify that value:
  1. Get the resource.
  2. Copy the resource to a temporary variable.
  3. Modify the temporary variable.
  4. Using the modified copy, set the resource.

Returns:

0
Success.
-1
An error occurred.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PtAppAddCallback(), PtAppGetResources(), PtAppRemoveCallback(), PtAppSetResources(), PtAppSetResource(), PtSetArg().