niHSDIO_ExportSignal
- Updated2023-02-21
- 3 minute(s) read
ViStatus = niHSDIO_ExportSignal ( ViSession vi, ViInt32 signal, ViConstString signalIdentifier, ViConstString outputTerminal);
Purpose
Use this function to route signals (clocks, triggers, and events) to the output terminal you specify. Refer to your device documentation for valid signal destinations.
Any routes created within a session persist after the session closes to prevent signal glitching. To unconfigure signal routes created in previous sessions, set the resetInstrument parameter in niHSDIO_InitGenerationSession or niHSDIO_InitAcquisitionSession to VI_TRUE or use niHSDIO_reset.
If you export a signal with this function and commit the session, the signal is routed to the output terminal you specify. If you then reconfigure the signal to have a different output terminal, the previous output terminal is tristated after the session is committed. If you change the output terminal to NIHSDIO_VAL_DO_NOT_EXPORT_STR or an empty string when you commit the operation, the previous output terminal is tristated.
Related topics:
Parameters
| Input | ||||
| Name | Type | Description | ||
| vi | ViSession | Identifies your instrument session. vi was obtained from the niHSDIO_InitAcquisitionSession or niHSDIO_InitGenerationSession function. | ||
| Signal | ViInt32 | Signal (clock, trigger, or event) to export. Defined Values NIHSDIO_VAL_SAMPLE_CLOCK (51)—Device Sample clock. NIHSDIO_VAL_REF_CLOCK (52)—Device Reference clock. NIHSDIO_VAL_START_TRIGGER (53)—Device Start trigger. NIHSDIO_VAL_REF_TRIGGER (54)—Device Reference trigger (dynamic acquisition only). NIHSDIO_VAL_ADVANCE_TRIGGER (61)—Device Advance trigger (dynamic acquisition only) NIHSDIO_VAL_PAUSE_TRIGGER (57)—Device Pause trigger (dynamic generation only). NIHSDIO_VAL_SCRIPT_TRIGGER (58)—Device Script trigger (dynamic generation only—requires signalIdentifier to describe a particular Script trigger). NIHSDIO_VAL_STOP_TRIGGER (82)—Device Stop trigger (dynamic generation only). NIHSDIO_VAL_DATA_ACTIVE_EVENT (55)— Data Active event (dynamic generation only). NIHSDIO_VAL_MARKER_EVENT (59)—Marker event (dynamic generation only—requires signalIdentifier to describe a particular marker). NIHSDIO_VAL_READY_FOR_START_EVENT (56)—Ready for Start event. NIHSDIO_VAL_READY_FOR_ADVANCE_EVENT (66)—Ready for Advance event (dynamic acquisition only). NIHSDIO_VAL_END_OF_RECORD_EVENT (68)—End of Record event (dynamic acquisition only). NIHSDIO_VAL_ONBOARD_REF_CLOCK (60)—Device onboard Reference clock (PCI devices only). |
||
| Signal Identifier | ViConstString | Describes the signal being exported. Defined Values
|
||
| Output Terminal | ViConstString | Output terminal where the signal is exported:
|
||
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:
|