NI RFSG Configuration: Attributes

niRFSG_ConfigureOutputEnabled

C Function Prototype

ViStatus niRFSG_ConfigureOutputEnabled (ViSession vi, ViBoolean output_enabled);

Purpose

Enables or disables signal output. Setting output_enabled to VI_FALSE while in the Generation state attenuates the generated signal so that no signal is output.

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Output Enabled

NI-RFSG Instrument Driver Programming Flow

RF List Mode

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
output_enabled	ViBoolean	Specifies whether you want to enable or disable the output.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_ConfigureIQEnabled

C Function Prototype

ViStatus niRFSG_ConfigureIQEnabled (ViSession vi, ViBoolean enabled);

Purpose

Configures the NI-RFSG device to apply I/Q (vector) modulation to the RF output signal. I/Q modulation must be enabled in order to generate any arbitrary (non-sine) waveform; if I/Q modulation is disabled, a sine tone is always generated, regardless if an arbitrary waveform is written. The NI-RFSG device must be in the Configuration state before calling this function.

	Note  This function is obsolete. Use the NIRFSG_ATTR_GENERATION_MODE attribute to enable I/Q modulation instead.
Upon device initialization, or calling the niRFSG_reset function or the niRFSG_ResetDevice function, I/Q modulation is disabled.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
enabled	ViBoolean	NI-RFSG sets the NIRFSG_ATTR_IQ_ENABLED attribute to this value. Defined Values:

VI_TRUE	Enables IQ (vector) modulation (arbitrary waveform generation)
VI_FALSE	Disables IQ (vector) modulation (sine wave generation)

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

Set/get/check Attribute

Set Attribute

niRFSG_SetAttributeViInt32

C Function Prototype

ViStatus niRFSG_SetAttributeViInt32 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViInt32 attributeValue);

Purpose

Sets the value of a ViInt32 attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
attributeValue	ViInt32	Specifies the value to which you want to set the attribute.

	Note  Some values may not be valid. The allowed values depend on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_SetAttributeViInt64

C Function Prototype

ViStatus niRFSG_SetAttributeViInt64 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViInt64 Attribute_Value);

Purpose

Sets the value of a ViInt64 attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
Attribute_Value	ViInt64	Pass the value to which you want to set the attribute.

	Note  Some values may not be valid. The allowed values depend on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_SetAttributeViReal64

C Function Prototype

ViStatus niRFSG_SetAttributeViReal64 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViReal64 attributeValue);

Purpose

Sets the value of a ViReal64 attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
attributeValue	ViReal64	Pass the value to which you want to set the attribute.

	Note  Some values may not be valid. The allowed values depend on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_SetAttributeViString

C Function Prototype

ViStatus niRFSG_SetAttributeViString (ViSession vi, ViConstString channelName, ViAttr attributeID, ViConstString attributeValue);

Purpose

Sets the value of a ViString attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
attributeValue	ViConstString	Pass the value to which you want to set the attribute.

	Note  Some values may not be valid. The allowed values depend on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_SetAttributeViBoolean

C Function Prototype

ViStatus niRFSG_SetAttributeViBoolean (ViSession vi, ViConstString channelName, ViAttr attributeID, ViBoolean attributeValue);

Purpose

Sets the value of a ViBoolean attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
attributeValue	ViBoolean	Pass the value to which you want to set the attribute.

	Note  Some values may not be valid. The allowed values depend on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_SetAttributeViSession

C Function Prototype

ViStatus niRFSG_SetAttributeViSession (ViSession vi, ViConstString channelName, ViAttr attributeID, ViSession attributeValue);

Purpose

Sets the value of a ViSession attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
attributeValue	ViSession	Pass the value to which you want to set the attribute.

	Note  Some values may not be valid. The allowed values depend on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

Get Attribute

niRFSG_GetAttributeViInt32

C Function Prototype

ViStatus niRFSG_GetAttributeViInt32 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViInt32* attributeValue);

Purpose

Queries the value of a ViInt32 attribute.

Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
Output
Name	Type	Description
attributeValue	ViInt32*	Returns the current value of the attribute. Pass the address of a ViInt32 variable.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_GetAttributeViInt64

C Function Prototype

ViStatus niRFSG_GetAttributeViInt64 (ViSession vi, ViConstString Channel_Name, ViAttr Attribute_ID, ViInt64* Attribute_Value);

Purpose

Queries the value of a ViInt64 attribute.

You can use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
Output
Name	Type	Description
Attribute_Value	ViInt64*	Returns the current value of the attribute. Pass the address of a ViInt64 variable.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_GetAttributeViReal64

C Function Prototype

ViStatus niRFSG_GetAttributeViReal64 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViReal64* attributeValue);

Purpose

Queries the value of a ViReal64 attribute.

Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
Output
Name	Type	Description
attributeValue	ViReal64*	Returns the current value of the attribute. Pass the address of a ViReal64 variable.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_GetAttributeViString

C Function Prototype

ViStatus niRFSG_GetAttributeViString (ViSession vi, ViConstString channelName, ViAttr attributeID, ViInt32 bufferSize, ViChar[] attributeValue);

Purpose

Queries the value of a ViString attribute.

Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid.

You must provide a ViString (ViChar array) to serve as a buffer for the value. Pass the number of bytes in the buffer as the Buffer Size parameter. If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the buffer size parameter, the function copies buffer size-1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is "123456" and the buffer size is 4, the function places "123" into the buffer and returns 7.

To call this function to get only the required buffer size, pass 0 for the buffer size and VI_NULL for the attribute value buffer.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
bufferSize	ViInt32	Pass the number of bytes in the ViChar buffer you specify for the attributeValue parameter. If you pass 0, you can pass VI_NULL for the attributeValue parameter.
Output
Name	Type	Description
attributeValue	ViChar[]	The buffer in which the function returns the current value of the attribute. The buffer must be of type ViChar and have at least as many bytes as indicated in the bufferSize parameter. If you specify 0 for the bufferSize parameter, you can pass VI_NULL for this parameter.

Return Value

Name	Type	Description
status	ViStatus

niRFSG_GetAttributeViBoolean

C Function Prototype

ViStatus niRFSG_GetAttributeViBoolean (ViSession vi, ViConstString channelName, ViAttr attributeID, ViBoolean* attributeValue);

Purpose

Queries the value of a ViBoolean attribute.

Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
Output
Name	Type	Description
attributeValue	ViBoolean*	Returns the current value of the attribute. Pass the address of a ViBoolean variable.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_GetAttributeViSession

C Function Prototype

ViStatus niRFSG_GetAttributeViSession (ViSession vi, ViConstString channelName, ViAttr attributeID, ViSession* attributeValue);

Purpose

Queries the value of a ViSession attribute.

Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

• State caching is disabled for the entire session or for the particular attribute.
• State caching is enabled, and the currently cached value is invalid.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
Output
Name	Type	Description
attributeValue	ViSession*	Returns the current value of the attribute. Pass the address of a ViSession variable.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

Check Attribute

niRFSG_CheckAttributeViInt32

C Function Prototype

ViStatus niRFSG_CheckAttributeViInt32 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViInt32 attributeValue);

Purpose

Checks the validity of a value you specify for a ViInt32 attribute.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
attributeValue	ViInt32	Pass the value that you want to verify as a valid value for the attribute.

	Note  Some of the values might not be valid depending on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_CheckAttributeViInt64

C Function Prototype

ViStatus niRFSG_CheckAttributeViInt64 (ViSession vi, ViConstString Channel_Name, ViAttr Attribute_ID, ViInt64 Attribute_Value);

Purpose

Checks the validity of a value you specify for a ViInt64 attribute.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
Attribute_Value	ViInt64	Pass the value that you want to verify as a valid value for the attribute.

	Note  Some of the values might not be valid depending on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_CheckAttributeViReal64

C Function Prototype

ViStatus niRFSG_CheckAttributeViReal64 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViReal64 attributeValue);

Purpose

Checks the validity of a value you specify for a ViReal64 attribute.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
attributeValue	ViReal64	Pass the value that you want to verify as a valid value for the attribute.

	Note  Some of the values might not be valid depending on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_CheckAttributeViString

C Function Prototype

ViStatus niRFSG_CheckAttributeViString (ViSession vi, ViConstString channelName, ViAttr attributeID, ViConstString attributeValue);

Purpose

Checks the validity of a value you specify for a ViString attribute.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
attributeValue	ViConstString	Pass the value that you want to verify as a valid value for the attribute. The value must be a NULL-terminated string.

	Note  Some of the values might not be valid depending on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_CheckAttributeViBoolean

C Function Prototype

ViStatus niRFSG_CheckAttributeViBoolean (ViSession vi, ViConstString channelName, ViAttr attributeID, ViBoolean attributeValue);

Purpose

Checks the validity of a value you specify for a ViBoolean attribute.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
attributeValue	ViBoolean	Pass the value that you want to verify as a valid value for the attribute.

	Note  Some of the values might not be valid depending on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_CheckAttributeViSession

C Function Prototype

ViStatus niRFSG_CheckAttributeViSession (ViSession vi, ViConstString channelName, ViAttr attributeID, ViSession attributeValue);

Purpose

Checks the validity of a value you specify for a ViSession attribute.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.
attributeValue	ViSession	Pass the value that you want to verify as a valid value for the attribute.

	Note  Some of the values might not be valid depending on the current settings of the instrument session.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niRFSG_ResetAttribute

C Function Prototype

ViStatus niRFSG_ResetAttribute (ViSession vi, ViConstString channelName, ViAttr attributeId);

Purpose

Resets the attribute to its default value.

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
channelName	ViConstString	Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"
attributeID	ViAttr	Pass the ID of an attribute.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors