Teledyne Princeton Instruments PICam 5.x, Programmer'S Manual

Page: 237 / 357

Chapter 7 Advanced Function APIs 237
7.4.7.2 PicamAdvanced_SetUserState()
Description
PicamAdvanced_SetUserState()
sets user-state information for the specified
hardware. This is especially useful when using callbacks as this can give access to user-
defined state within the callback.
NOTE:
This API is thread safe.
Syntax
The syntax for
PicamAdvanced_SetUserState()
is:
PICAM_API PicamAdvanced_SetUserState(
PicamHandle camera_or_accessory,
void* user_state);
Input Parameters
Input parameters for
PicamAdvanced_SetUserState()
are:
Output Parameters
Output parameters for
PicamAdvanced_SetUserState()
are:
camera_or_accessory:
Handle for the hardware for which user state information is to be
configured.
Valid values are:
•
device
handle;
• model handle.
NOTE:
device
and
model
share the same user state.
user_state: Pointer to the memory location where user-state information is
stored.