NI-HSDIO C Function Reference

niHSDIO_SendSoftwareEdgeTrigger

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

ViStatus = niHSDIO_SendSoftwareEdgeTrigger ( ViSession vi, ViInt32 triggerName, ViConstString triggerIdentifier);

Purpose

Use this function to force a particular edge, pattern match, or software trigger to occur. This function applies to the Start, Reference, Advance, Script, and Stop triggers, and it is valid if the particular trigger is configured for edge, pattern match, or software triggering. For edge or pattern match triggers you can use this function as a software override.

Related topics:

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi was obtained from the niHSDIO_InitAcquisitionSession or niHSDIO_InitGenerationSession function.
Trigger ViInt32 The trigger to assert.

Defined Values

NIHSDIO_VAL_START_TRIGGER (53)—Start trigger for dynamic acquisition or generation.
NIHSDIO_VAL_REF_TRIGGER (54)—Reference trigger for dynamic acquisition.
NIHSDIO_VAL_SCRIPT_TRIGGER (58)—Script trigger for dynamic generation.
NIHSDIO_VAL_ADVANCE_TRIGGER (61)—Advance trigger for dynamic acquisition.
NIHSDIO_VAL_STOP_TRIGGER (82)—Stop trigger for dynamic generation.
Trigger Identifier ViConstString Describes the script trigger. For example, "ScriptTrigger0" could be the identifier for the Script trigger, or you could have an empty string for the Start, Reference, Advance, and Stop triggers.

Defined Values

"ScriptTrigger0"
"ScriptTrigger1"
"ScriptTrigger2"
"ScriptTrigger3"
"" (empty string) or VI_NULL

"ScriptTrigger3" is not available when using the NI 6544/6545/6547/6548.

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:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience