IviSwtch_InitiateScan

CVI/LabWindows IVI Class Driver

IviSwtch_InitiateScan

IviSwtchScanner Capability Group

C Function Prototype

ViStatus IviSwtch_InitiateScan (ViSession vi);

Purpose

This function initiates a scan using the scan list and triggers you configure with the IviSwtch_ConfigureScanList and IviSwtch_ConfigureScanTrigger functions. This function returns immediately.

If the scan list contained within the IVISWTCH_ATTR_SCAN_LIST attribute is empty, this function returns the IVISWTCH_ERROR_EMPTY_SCAN_LIST error.

After you start the scanning operation, you cannot perform any other operation other than GetAttribute, AbortScan, or SendSoftwareTrigger. All other functions return the IVISWTCH_ERROR_SCAN_IN_PROGRESS error.

To stop the scanning operation, call the IviSwtch_AbortScan function.

The first scan advanced output trigger is generated after the IviSwtch_InitiateScan operation, and not after the IviSwtch_ConfigureScanList function when the scan list is first downloaded into the instrument.

This function applies default values to attributes that you have not set. For more information on default values, consult default values.

Note  This function performs interchangeability checking when the IVISWTCH_ATTR_INTERCHANGE_CHECK attribute is set to VI_TRUE. Use NI Spy to view interchangeability warnings. Alternately, you may use the IviSwtch_GetNextInterchangeWarning function to retrieve interchangeability warnings. For more information about interchangeability checking, consult interchangeability.

Parameter

Name Type Description
vi ViSession The instrument handle that you obtain from the IviSwtch_init or IviSwtch_InitWithOptions functions. The handle identifies a particular IVI session.

Return Values