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

Page: 158 / 357

158 PICam™ 5.x Programmer’s Manual Issue 11
5.4.2.17 Picam_EstimateTimeToStatusParameterValue()
Description
Picam_EstimateTimeToStatusParameterValue()
returns the estimated time, in
milliseconds, for a particular status to be reached.
Syntax
The syntax for
Picam_EstimateTimeToStatusParameterValue()
is:
PICAM_API Picam_EstimateTimeToStatusParameterValue(
PicamHandle camera_or_accessory,
PicamParameter parameter,
piint value,
piint* estimated_time);
Input Parameters
Input parameters for
Picam_EstimateTimeToStatusParameterValue()
are:
Output Parameters
Output parameters for
Picam_EstimateTimeToStatusParameterValue()
are:
Advanced API Usage
When used in conjunction with Advanced APIs, if
camera_or_accessory
is a camera
handle, it may be a handle to either the:
•
device
, or
•
model
.
Related APIs
For additional information, refer to the following related APIs:
•
Picam_CanWaitForStatusParameter()
•
Picam_GetStatusParameterPurview()
camera_or_accessory: Handle for the hardware whose time to status will be estimated.
parameter:
Specifies the parameter whose time to status will be estimated.
NOTE:
The specified parameter must be a waitable status.
Refer to
Picam_CanWaitForStatusParameter()
for
additional information.
value:
Specifies the status for which the time is to be estimated.
NOTE:
The specified value must be in the status purview.
Refer to
Picam_GetStatusParameterPurview()
for
additional information.
estimated_time:
Pointer to the estimated time in milliseconds.
NOTE:
If the time cannot be estimated, -1 is returned.