NI-FGEN C Function Reference

niFgen_ConfigureDigitalLevelScriptTrigger

  • Updated2023-02-21
  • 2 minute(s) read

ViStatus niFgen_ConfigureDigitalLevelScriptTrigger (ViSession vi, ViConstString triggerID, ViConstString source, ViInt32 triggerWhen);

Purpose

Configures the specified Script Trigger for digital level triggering.

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niFgen_init, niFgen_InitWithOptions, or niFgen_InitializeWithChannels functions and identifies a particular instrument session.
triggerID ViConstString Specifies the Script Trigger used for triggering.

Defined Values

"ScriptTrigger0"Script Trigger 0
"ScriptTrigger1"Script Trigger 1
"ScriptTrigger2"Script Trigger 2
"ScriptTrigger3"Script Trigger 3

Default Value: "ScriptTrigger0"

source ViConstString Specifies which trigger source the signal generator uses.

Defined Values

"PFI0"PFI 0
"PFI1"PFI 1
"PFI2"PFI 2
"PFI3"PFI 3
"PFI4"PFI 4
"PFI5"PFI 5
"PFI6"PFI 6
"PFI7"PFI 7
"PXI_Trig0" PXI trigger line 0 or RTSI line 0
"PXI_Trig1" PXI trigger line 1 or RTSI line 1
"PXI_Trig2" PXI trigger line 2 or RTSI line 2
"PXI_Trig3" PXI trigger line 3 or RTSI line 3
"PXI_Trig4" PXI trigger line 4 or RTSI line 4
"PXI_Trig5" PXI trigger line 5 or RTSI line 5
"PXI_Trig6" PXI trigger line 6 or RTSI line 6
"PXI_Trig7" PXI trigger line 7 or RTSI line 7
"PXI_Star"PXI star trigger line

Default Value: "PFI0"

triggerWhen ViInt32 Specifies whether the Script Trigger asserts on a high or low digital level.

Defined Values

"HighLevel"Script Trigger asserts on a high digital level.
"LowLevel"Script Trigger asserts on a low digital level.

Default Value: "HighLevel"

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred. To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience