niFgen_ConfigureOutputEnabled

NI-FGEN C Function

niFgen_ConfigureOutputEnabled

ViStatus niFgen_ConfigureOutputEnabled (ViSession vi, ViConstString channelName, ViBoolean enabled);

Purpose

Enables or disables the signal generator output.

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session.
channelName ViConstString Specifies the channel name for which you want to enable the output.

Default Value: "0"

enabled ViBoolean Specifies whether you want to enable or disable the output. NI-FGEN uses this value to set the NIFGEN_ATTR_OUTPUT_ENABLED attribute.

Defined Values

VI_TRUE Enable the output
VI_FALSE Disable the output

Default Value: VI_TRUE

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