Sets the value of a ViInt32 attribute. This is a low-level function that you can use to set the values of instrument-specific attributes and inherent IVI 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.
Note NI-SCOPE contains high-level functions that set most of the instrument attributes. Use the high-level functions as much as possible because they handle order dependencies and multithread locking for you. In addition, high-level functions perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the Set Attribute 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
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
value
ViInt32
The value that you want to set the attribute. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Sets the value of a ViInt64 attribute. This is a low-level function that you can use to set the values of instrument-specific attributes and inherent IVI 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.
Note NI-SCOPE contains high-level functions that set most of the instrument attributes. Use the high-level functions as much as possible because they handle order dependencies and multithread locking for you. In addition, high-level functions perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the Set Attribute 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
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
value
ViInt64
The value that you want to set the attribute. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Sets the value of a ViReal64 attribute. This is a low-level function that you can use to set the values of instrument-specific attributes and inherent IVI 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.
Note NI-SCOPE contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible because they handle order dependencies and multithread locking for you. In addition, the high-level functions perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the Set Attribute 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
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
value
ViReal64
The value that you want to set the attribute to. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
This is a low-level function that you can use to set the values of instrument-specific attributes and inherent IVI 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.
Note NI-SCOPE contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible because they handle order dependencies and multithread locking for you. In addition, the high-level functions 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
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
value
ViConstString
The value that you want to set the attribute to. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Sets the value of a ViBoolean attribute. This is a low-level function that you can use to set the values of instrument-specific attributes and inherent IVI 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.
Note NI-SCOPE contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible because they handle order dependencies and multithread locking for you. In addition, the high-level functions 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
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
value
ViBoolean
The value that you want to set the attribute to. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Sets the value of a ViSession attribute. This is a low-level function that you can use to set the values of instrument-specific attributes and inherent IVI 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.
Note NI-SCOPE contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible because they handle order dependencies and multithread locking for you. In addition, the high-level functions perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the Set Attribute 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
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
value
ViSession
The value that you want to set the attribute to. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Queries the value of a ViInt32 attribute. You can use this function to get the values of instrument-specific attributes and inherent IVI 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
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
Output
Name
Type
Description
value
ViInt32*
Returns the current value of the attribute.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Queries the value of a ViInt64 attribute. You can use this function to get the values of instrument-specific attributes and inherent IVI 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
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
Output
Name
Type
Description
value
ViInt64*
Returns the current value of the attribute.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Queries the value of a ViReal64 attribute. You can use this function to get the values of instrument-specific attributes and inherent IVI 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
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
Output
Name
Type
Description
value
ViReal64*
Returns the current value of the attribute; pass the address of a ViReal64 variable.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Queries the value of a ViString attribute. You can use this function to get the values of instrument-specific attributes and inherent IVI 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 ViChar array to serve as a buffer for the value. You pass the number of bytes in the buffer as the bufSize. If the current value of the attribute, including the terminating NUL byte, is larger than the size you indicate in the bufSize, the function copies (bufSize – 1) bytes into the buffer, places an ASCII NUL byte at the end of the buffer, and returns the bufSize you must pass to get the entire value. For example, if the value is 123456 and the bufSize is 4, the function places 123 into the buffer and returns 7. If you want to call this function just to get the required buffer size, you can pass 0 for the bufSize and VI_NULL for the value.
Parameters
Input
Name
Type
Description
vi
ViSession
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
bufSize
ViInt32
The number of bytes in the ViChar array you specify for value.
Output
Name
Type
Description
value[]
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 bufSize.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Queries the value of a ViBoolean attribute. You can use this function to get the values of instrument-specific attributes and inherent IVI 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
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
Output
Name
Type
Description
value
ViBoolean*
Returns the current value of the attribute; pass the address of a ViBoolean variable.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Queries the value of a ViSession attribute. You can use this function to get the values of instrument-specific attributes and inherent IVI 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
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
Output
Name
Type
Description
value
ViSession*
Returns the current value of the attribute; pass the address of a ViSession variable.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Verifies the validity of a value you specify for a ViInt32 attribute.
Parameters
Input
Name
Type
Description
vi
ViSession
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
value
ViInt32
The value that you want to verify for the attribute. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Verifies the validity of a value you specify for a ViInt64 attribute.
Parameters
Input
Name
Type
Description
vi
ViSession
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
value
ViInt64
The value that you want to verify for the attribute. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Verifies the validity of a value you specify for a ViReal64 attribute.
Parameters
Input
Name
Type
Description
vi
ViSession
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
value
ViReal64
The value that you want to verify for the attribute. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Verifies the validity of a value you specify for a ViString attribute.
Parameters
Input
Name
Type
Description
vi
ViSession
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
value
ViConstString
The value that you want to verify for the attribute. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Verifies the validity of a value you specify for a ViBoolean attribute.
Parameters
Input
Name
Type
Description
vi
ViSession
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute
value
ViBoolean
The value that you want to verify for the attribute. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
Verifies the validity of a value you specify for a ViSession attribute.
Parameters
Input
Name
Type
Description
vi
ViSession
The instrument handle you obtain from niScope_init that identifies a particular instrument session.
channelList
ViConstString
The channel to configure. For more information, refer to Channel String Syntax.
attributeID
ViAttr
The ID of an attribute.
value
ViSession
The value that you want to verify for the attribute. Some values might not be valid depending on the current settings of the instrument session.
Return Value
Name
Type
Description
Status
ViStatus
Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:
