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

Page: 159 / 357

Chapter 5 Configuration APIs 159
5.4.2.18 Picam_WaitForStatusParameterValue()
Description
Picam_WaitForStatusParameterValue()
waits for a particular status to be reached
or until
time_out
milliseconds has elapsed.
PicamError_TimeOutOccurred
is returned if
time_out
has elapsed.
Syntax
The syntax for
Picam_WaitForStatusParameterValue()
is:
PICAM_API Picam_WaitForStatusParameterValue(
PicamHandle camera_or_accessory,
PicamParameter parameter,
piint value,
piint time_out);
Input Parameters
Input parameters for
Picam_WaitForStatusParameterValue()
are:
Output Parameters
There are no output parameters associated with
Picam_WaitForStatusParameterValue()
.
Related APIs
For additional information, refer to the following related APIs:
•
Picam_CanWaitForStatusParameter()
•
Picam_GetStatusParameterPurview()
camera_or_accessory: Handle for the hardware whose status will be awaited.
parameter:
Specifies the parameter whose status will be awaited.
NOTE:
The specified parameter must be a waitable status.
Refer to
Picam_CanWaitForStatusParameter()
for
additional information.
value:
Specifies the status to await.
NOTE:
The specified value must be in the status purview.
Refer to
Picam_GetStatusParameterPurview()
for
additional information.
time_out:
Specifies the time to wait, in milliseconds.
NOTE:
Use –1 to wait indefinitely.