niHSDIO_CommitDynamic
- Updated2023-02-21
- 2 minute(s) read
ViStatus = niHSDIO_CommitDynamic ( ViSession vi);
Purpose
Programs the hardware for the dynamic data operation using the attributes you select. Before entering the committed state, most attribute values are stored in software only; these values have not yet been programmed to the hardware. After the session is committed, the hardware is configured.
For many operations it is not necessary to explicitly call this function because the following functions implicitly commit:
- niHSDIO_Initiate
- niHSDIO_WriteScript
- Read Waveform functions
- Write Named Waveform functions
Start the operation with the niHSDIO_Initiate function. Running this function while a dynamic operation is in progress returns an error. Committing only programs attributes changed since previous commits.
 |
Note Committing some attributes may have immediate effects seen on external instrument connectors. Voltage levels are an example of an attribute with an immediate effect when committed. |
Before committing a session that requires an external clock, ensure the external clock is available. Otherwise you receive an error that the device could not find or lock to the external clock.
Related topics:
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi was obtained from the niHSDIO_InitAcquisitionSession or niHSDIO_InitGenerationSession function. |
Return Value
| Name | Type | Description | ||||||||
| Status | ViStatus | Reports the status of this operation. To obtain a text description of the status code, call the niHSDIO_error_message function. To obtain additional information concerning the error condition, use the niHSDIO_GetError and niHSDIO_ClearError functions. The general meaning of the status code is as follows:
|