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

Page: 254 / 357

254 PICam™ 5.x Programmer’s Manual Issue 11
7.4.9.9 PicamAdvanced_NotifyWhenStatusParameterValue()
Description
PicamAdvanced_NotifyWhenStatusParameterValue()
sets a function to call once
when the value of a specified status has been met or when an error has occurred.
NOTE:
Multiple functions may be set. When this is the case, the
functions are called in the order in which they have been
set.
Set callbacks are called asynchronously from within the thread.
Syntax
The syntax for
PicamAdvanced_NotifyWhenStatusParameterValue()
is:
PICAM_API PicamAdvanced_NotifyWhenStatusParameterValue(
PicamHandle device_or_accessory,
PicamParameter parameter,
piint value,
PicamWhenStatusParameterValueCallback when);
Input Parameters
Input parameters for
PicamAdvanced_NotifyWhenStatusParameterValue()
are:
Output Parameters
There are no output parameters associated with
PicamAdvanced_NotifyWhenStatusParameterValue()
.
Related APIs
For additional information, refer to the following related APIs:
•
Picam_CanWaitForStatusParameter()
.
• PicamAdvanced_CancelNotifyWhenStatusParameterValue()
.
device_or_accessory:
Handle for the hardware for which the callback is being set.
parameter: The parameter for which the callback is being set.
NOTE: The specified parameter must be a waitable status.
Refer to
Picam_CanWaitForStatusParameter() for
additional information.
value: The status value to notify when met.
when:
The name assigned to the callback function being set.