Text preview for : Chr6310A Help for Visual Basic.txt part of Chroma Chr6310A Help for Visual Basic Chroma sw 6314A Chr6310A Help for Visual Basic.txt
Back to : Chr6310A Help for Visual | Home
Programmable DC Electronic Load
________________________________________________________________________________
Introduction:
This instrument driver provides programming support for Programmable DC Electronic Load.
It contains functions for opening, configuring, taking measurements from, and
closing the instrument.
________________________________________________________________________________
Assumptions:
To successfully use this module, the following conditions must be met:
For GPIB instrument drivers:
- the instrument is connected to the GPIB.
- the GPIB address supplied to the initialize function must match the
GPIB address of the instrument.
For VXI instrument drivers:
- the instrument is installed in the VXI mainframe and you are
using one of the following controller options:
Embedded controller
MXI
MXI2
GPIB-VXI
- the logical address supplied to the initialize function must
match the logical address of the instrument.
For RS-232 instrument drivers:
- the instrument is connected to the RS-232 interface.
- the COM port, baud rate, parity, and timeout supplied to the
initialize function must match the settings of the instrument.
________________________________________________________________________________
Error and Status Information:
Each function in this instrument driver returns a status code that
either indicates success or describes an error or warning condition.
Your program should examine the status code from each call to an
instrument driver function to determine if an error occurred.
The general meaning of the status code is as follows:
Value Meaning
-------------------------------
0 Success
Positive Values Warnings
Negative Values Errors
The description of each instrument driver function lists possible error
codes and their meanings
________________________________________________________________________________
How To Use This Document:
Use this document as a programming reference manual.
It describes each function in the
Programmable DC Electronic Load
instrument. The functions appear in alphabetical order, with a description
of the function and its Visual Basic syntax, a description of each parameter,
and a list of possible error codes.
________________________________________________________________________________
Function Tree Layout:
Class/Panel Name: Function Name:
Initialize Chr6310A_init
Init Interface Chr6310A_InitInterface
Initialize With Options Chr6310A_InitWithOptions
Application Functions
Configure Function
Set Configure Von Chr6310A_Set_Configure_Von
Set Configure Voltage Range Chr6310A_Set_Configure_Voltage_Range
Set Configure Voltage Latch Chr6310A_Set_Configure_Voltage_Latch
Set Configure Von Latch Reset Chr6310A_Set_Configure_Von_Latch_Reset
Set Configure Auto Load Chr6310A_Set_Configure_Auto_Load
Set Configure Auto Mode Chr6310A_Set_Configure_Auto_Mode
Set Configure Sound Chr6310A_Set_Configure_Sound
Set Configure Remote(For RS232) Chr6310A_Set_Configure_Remote
Set Configure Save Chr6310A_Set_Configure_Save
Set Configure LOADON Chr6310A_Set_Configure_Load
Set Configure Timing State Chr6310A_Set_Configure_Timing_State
Set Configure Timing Trigger Chr6310A_Set_Configure_Timing_Trigger
Set Configure Timing Timeout Chr6310A_Set_Configure_Timing_Timeout
Set Configure Voff State Chr6310A_Set_Configure_Voff_State
Set Configure Voff Final V Chr6310A_Set_Configure_Voff_Final_V
Set Configure Measure Average Chr6310A_Set_Configure_Measure_Average
Set Configure Digital IO Chr6310A_Set_Configure_Digital_IO
Set Configure Key Chr6310A_Set_Configure_Key
Set Configure Echo Chr6310A_Set_Configure_Echo
Query
Get Configure Von Chr6310A_Get_Configure_Von
Get Configure Voltage Range Chr6310A_Get_Configure_Voltage_Range
Get Configure Voltage Latch Chr6310A_Get_Configure_Voltage_Latch
Get Configure Auto Load Chr6310A_Get_Configure_Auto_Load
Get Configure Auto Mode Chr6310A_Get_Configure_Auto_Mode
Get Configure Sound Chr6310A_Get_Configure_Sound
Get Configure LOADON Chr6310A_Get_Configure_Load
Get Configure Timing State Chr6310A_Get_Configure_Timing_State
Get Configure Timing Trigger Chr6310A_Get_Configure_Timing_Trigger
Get Configure Timing Timeout Chr6310A_Get_Configure_Timing_Timeout
Get Configure Voff State Chr6310A_Get_Configure_Voff_State
Get Configure Voff Final V Chr6310A_Get_Configure_Voff_Final_V
Get Configure Measure Average Chr6310A_Get_Configure_Measure_Average
Get Configure Digital IO Chr6310A_Get_Configure_Digital_IO
Get Configure Key Chr6310A_Get_Configure_Key
Get Configure Echo Chr6310A_Get_Configure_Echo
Channel Function
Set Channel Load Chr6310A_Set_Channel_Load
Set Channel Active Chr6310A_Set_Channel_Active
Set Channel Synchronized Chr6310A_Set_Channel_Synchronized
Query
Get Channel Load Chr6310A_Get_Channel_Load
Get Min of Channel Load Chr6310A_Get_Min_of_Channel_Load
Get Max of Channel Load Chr6310A_Get_Max_of_Channel_Load
Get Channel Synchronized Chr6310A_Get_Channel_Synchronized
Get Channel ID Chr6310A_Get_Channel_ID
Load Function
Set Load State Chr6310A_Set_Load_State
Set Load Short State Chr6310A_Set_Load_Short_State
Set Load Short Key Chr6310A_Set_Load_Short_Key
Set Load Protection Clear Chr6310A_Set_Load_Protection_Clear
Set Load Clear Chr6310A_Set_Load_Clear
Set Load Save Chr6310A_Set_Load_Save
Query
Get Load State Chr6310A_Get_Load_State
Get Load Short State Chr6310A_Get_Load_Short_State
Get Load Short Key Chr6310A_Get_Load_Short_Key
Get Load Protection Status Chr6310A_Get_Load_Protection_Status
All Run
RUN Chr6310A_RUN
All Abort
ABORT Chr6310A_ABORT
Show Display
Show Display Chr6310A_Show_Display
CLS Chr6310A_CLS
Set ESE Chr6310A_Set_ESE
Set OPC Chr6310A_Set_OPC
RCL(Restore Memory) Chr6310A_RCL
RST Chr6310A_RST
SAV(Store Memory) Chr6310A_SAV
Set SRE Chr6310A_Set_SRE
Query
Get ESR Chr6310A_Get_ESR
Get Identification String Chr6310A_Get_Identification_String
Get OPC Chr6310A_Get_OPC
Get RDT Chr6310A_Get_RDT
Get STB Chr6310A_Get_STB
Configuration Functions
Set/Get/Check Attribute
Set Attribute
Set Attribute ViInt32 Chr6310A_SetAttributeViInt32
Set Attribute ViReal64 Chr6310A_SetAttributeViReal64
Set Attribute ViString Chr6310A_SetAttributeViString
Set Attribute ViBoolean Chr6310A_SetAttributeViBoolean
Set Attribute ViSession Chr6310A_SetAttributeViSession
Get Attribute
Get Attribute ViInt32 Chr6310A_GetAttributeViInt32
Get Attribute ViReal64 Chr6310A_GetAttributeViReal64
Get Attribute ViString Chr6310A_GetAttributeViString
Get Attribute ViBoolean Chr6310A_GetAttributeViBoolean
Get Attribute ViSession Chr6310A_GetAttributeViSession
Check Attribute
Check Attribute ViInt32 Chr6310A_CheckAttributeViInt32
Check Attribute ViReal64 Chr6310A_CheckAttributeViReal64
Check Attribute ViString Chr6310A_CheckAttributeViString
Check Attribute ViBoolean Chr6310A_CheckAttributeViBoolean
Check Attribute ViSession Chr6310A_CheckAttributeViSession
Action/Status Functions
Load Mode
Set Mode Chr6310A_Set_Mode
Query
Get Mode Chr6310A_Get_Mode
CC&CCD Mode
Set CC Static L1 Chr6310A_Set_CC_Static_L1
Set CC Static L2 Chr6310A_Set_CC_Static_L2
Set CC Static Rise Slew Rate Chr6310A_Set_CC_Static_Rise_Slew_Rate
Set CC Static Fall Slew Rate Chr6310A_Set_CC_Static_Fall_Slew_Rate
Set CC Dynamic L1 Chr6310A_Set_CC_Dynamic_L1
Set CC Dynamic L2 Chr6310A_Set_CC_Dynamic_L2
Set CC Dynamic Rise Slew Rate Chr6310A_Set_CC_Dynamic_Rise_Slew_Rate
Set CC Dynamic Fall Slew Rate Chr6310A_Set_CC_Dynamic_Fall_Slew_Rate
Set CC Dynamic T1 Chr6310A_Set_CC_Dynamic_T1
Set CC Dynamic T2 Chr6310A_Set_CC_Dynamic_T2
Query
Get CC Static L1 Chr6310A_Get_CC_Static_L1
Get CC Static L2 Chr6310A_Get_CC_Static_L2
Get CC Static Rise Slew Rate Chr6310A_Get_CC_Static_Rise_Slew_Rate
Get CC Static Fall Slew Rate Chr6310A_Get_CC_Static_Fall_Slew_Rate
Get CC Dynamic L1 Chr6310A_Get_CC_Dynamic_L1
Get CC Dynamic L2 Chr6310A_Get_CC_Dynamic_L2
Get CC Dynamic Rise Slew Rate Chr6310A_Get_CC_Dynamic_Rise_Slew_Rate
Get CC Dynamic Fall Slew Rate Chr6310A_Get_CC_Dynamic_Fall_Slew_Rate
Get CC Dynamic T1 Chr6310A_Get_CC_Dynamic_T1
Get CC Dynamic T2 Chr6310A_Get_CC_Dynamic_T2
CR Mode
Set CR Static L1 Chr6310A_Set_CR_Static_L1
Set CR Static L2 Chr6310A_Set_CR_Static_L2
Set CR Static Rise Slew Rate Chr6310A_Set_CR_Static_Rise_Slew_Rate
Set CR Static Fall Slew Rate Chr6310A_Set_CR_Static_Fall_Slew_Rate
Query
Get CR Static L1 Chr6310A_Get_CR_Static_L1
Get CR Static L2 Chr6310A_Get_CR_Static_L2
Get CR Static Rise Slew Rate Chr6310A_Get_CR_Static_Rise_Slew_Rate
Get CR Static Fall Slew Rate Chr6310A_Get_CR_Static_Fall_Slew_Rate
CV Mode
Set CV Static L1 Chr6310A_Set_CV_Static_L1
Set CV Static L2 Chr6310A_Set_CV_Static_L2
Set CV Current Limit Chr6310A_Set_CV_Current_Limit
Set CV Response Speed Chr6310A_Set_CV_Response_Speed
Query
Get CV Static L1 Chr6310A_Get_CV_Static_L1
Get CV Static L2 Chr6310A_Get_CV_Static_L2
Get CV Current Limit Chr6310A_Get_CV_Current_Limit
Get CV Response Speed Chr6310A_Get_CV_Response_Speed
CP Mode
Set CP Static L1 Chr6310A_Set_CP_Static_L1
Set CP Static L2 Chr6310A_Set_CP_Static_L2
Set CP Static Rise Slew Rate Chr6310A_Set_CP_Static_Rise_Slew_Rate
Set CP Static Fall Slew Rate Chr6310A_Set_CP_Static_Fall_Slew_Rate
Query
Get CP Static L1 Chr6310A_Get_CP_Static_L1
Get CP Static L2 Chr6310A_Get_CP_Static_L2
Get CP Static Rise Slew Rate Chr6310A_Get_CP_Static_Rise_Slew_Rate
Get CP Static Fall Slew Rate Chr6310A_Get_CP_Static_Fall_Slew_Rate
OCP Mode(63110A not support)
Set OCP Test Chr6310A_Set_OCP_Test
Set OCP Range Chr6310A_Set_OCP_Range
Set OCP Start Current Chr6310A_Set_OCP_Start_Current
Set OCP End Current Chr6310A_Set_OCP_End_Current
Set OCP Step Count Chr6310A_Set_OCP_Step_Count
Set OCP Dwell Time Chr6310A_Set_OCP_Dwell_Time
Set OCP Trigger Voltage Chr6310A_Set_OCP_Trigger_Voltage
Set OCP Specification Low Chr6310A_Set_OCP_Specification_Low
Set OCP Specification High Chr6310A_Set_OCP_Specification_High
Query OCP Result Chr6310A_Query_OCP_Result
Query
Get OCP Range Chr6310A_Get_OCP_Range
Get OCP Start Current Chr6310A_Get_OCP_Start_Current
Get OCP End Current Chr6310A_Get_OCP_End_Current
Get OCP Step Count Chr6310A_Get_OCP_Step_Count
Get OCP Dwell Time Chr6310A_Get_OCP_Dwell_Time
Get OCP Trigger Voltage Chr6310A_Get_OCP_Trigger_Voltage
Get OCP Specification Low Chr6310A_Get_OCP_Specification_Low
Get OCP Specification High Chr6310A_Get_OCP_Specification_High
OPP Mode(63110A not support)
Set OPP Test Chr6310A_Set_OPP_Test
Set OPP Range Chr6310A_Set_OPP_Range
Set OPP Start Power Chr6310A_Set_OPP_Start_Power
Set OPP End Power Chr6310A_Set_OPP_End_Power
Set OPP Step Count Chr6310A_Set_OPP_Step_Count
Set OPP Dwell Time Chr6310A_Set_OPP_Dwell_Time
Set OPP Trigger Voltage Chr6310A_Set_OPP_Trigger_Voltage
Set OPP Specification Low Chr6310A_Set_OPP_Specification_Low
Set OPP Specification High Chr6310A_Set_OPP_Specification_High
Query OPP Result Chr6310A_Query_OPP_Result
Query
Get OPP Range Chr6310A_Get_OPP_Range
Get OPP Start Power Chr6310A_Get_OPP_Start_Power
Get OPP End Power Chr6310A_Get_OPP_End_Power
Get OPP Step Count Chr6310A_Get_OPP_Step_Count
Get OPP Dwell Time Chr6310A_Get_OPP_Dwell_Time
Get OPP Trigger Voltage Chr6310A_Get_OPP_Trigger_Voltage
Get OPP Specification Low Chr6310A_Get_OPP_Specification_Low
Get OPP Specification High Chr6310A_Get_OPP_Specification_High
LED Mode(For 63110A Model)
Set LED Voltage Out Chr6310A_Set_LED_Voltage_Out
Set LED Current Out Chr6310A_Set_LED_Current_Out
Set LED Rd Coefficient Chr6310A_Set_LED_Rd_Coefficient
Set LED Rd Ohm Chr6310A_Set_LED_Rd_Ohm
Set LED VF Chr6310A_Set_LED_VF
Set Configure Current Range Chr6310A_Set_Configure_Current_Range
Set Configure Rd Select Chr6310A_Set_Configure_Rd_Select
Set Configure Rr Chr6310A_Set_Configure_Rr
Set Configure Rr Select Chr6310A_Set_Configure_Rr_Select
Set Configure Rr Set Chr6310A_Set_Configure_Rr_Set
Set Configure Short Chr6310A_Set_Configure_Short
Set Configure Response Select Chr6310A_Set_Configure_Response_Select
Set Configure Response Set Chr6310A_Set_Configure_Response_Set
Set Configure Set All LED Chr6310A_Set_Configure_Set_All_LED
Query
Get LED Voltage Out Chr6310A_Get_LED_Voltage_Out
Get LED Current Out Chr6310A_Get_LED_Current_Out
Get LED Rd Coefficient Chr6310A_Get_LED_Rd_Coefficient
Get LED Rd Ohm Chr6310A_Get_LED_Rd_Ohm
Get LED VF Chr6310A_Get_LED_VF
Get Configure Current Range Chr6310A_Get_Configure_Current_Range
Get Configure Rd Select Chr6310A_Get_Configure_Rd_Select
Get Configure Rr Chr6310A_Get_Configure_Rr
Get Configure Rr Select Chr6310A_Get_Configure_Rr_Select
Get Configure Rr Set Chr6310A_Get_Configure_Rr_Set
Get Configure Short Chr6310A_Get_Configure_Short
Get Configure Response Select Chr6310A_Get_Configure_Response_Select
Get Configure Response Set Chr6310A_Get_Configure_Response_Set
Get Configure Set All LED Chr6310A_Get_Configure_Set_All_LED
Program(63110A not support)
Set Program Parameters Chr6310A_Set_Program_Parameters
Set Sequence Parameters Chr6310A_Set_Sequence_Parameters
Set Program Save Chr6310A_Set_Program_Save
Set Program Run Chr6310A_Set_Program_Run
Set Program Key Chr6310A_Set_Program_Key
Query
Get Program Parameters Chr6310A_Get_Program_Parameters
Get Sequence Parameters Chr6310A_Get_Sequence_Parameters
Get Program Run Chr6310A_Get_Program_Run
Specification
Set Specification Unit Chr6310A_Set_Specification_Unit
Set Specification Voltage Chr6310A_Set_Specification_Voltage
Set Specification Current Chr6310A_Set_Specification_Current
Set Specification Power(63110A) Chr6310A_Set_Specification_Power
Set Specification Test Chr6310A_Set_Specification_Test
Query
Get Specification Unit Chr6310A_Get_Specification_Unit
Get Spec_Volt Result Chr6310A_Get_Spec_Volt_Result
Get Spec_Curr Result Chr6310A_Get_Spec_Curr_Result
Get Spec_All_Channel Result Chr6310A_Get_Spec_All_Channel_Result
Get Specification Voltage Chr6310A_Get_Specification_Voltage
Get Specification Current Chr6310A_Get_Specification_Current
Get Specification Power(63110A) Chr6310A_Get_Specification_Power
Get Specification Test Chr6310A_Get_Specification_Test
Data Functions
Fetch Function
Fetch Voltage Chr6310A_Fetch_Voltage
Fetch Current Chr6310A_Fetch_Current
Fetch Power Chr6310A_Fetch_Power
Fetch Status Chr6310A_Fetch_Status
Fetch All Voltage Chr6310A_Fetch_All_Voltage
Fetch All Current Chr6310A_Fetch_All_Current
Fetch All Power Chr6310A_Fetch_All_Power
Fetch Time Chr6310A_Fetch_Time
Measure Function
Measure Voltage Chr6310A_Measure_Voltage
Measure Current Chr6310A_Measure_Current
Measure Power Chr6310A_Measure_Power
Measure All Voltage Chr6310A_Measure_All_Voltage
Measure All Current Chr6310A_Measure_All_Current
Measure All Power Chr6310A_Measure_All_Power
Set Measure Input Chr6310A_Set_Measure_Input
Set Measure Scan Chr6310A_Set_Measure_Scan
Query
Get Measure Input Chr6310A_Get_Measure_Input
Get Measure Scan Chr6310A_Get_Measure_Scan
Utility Functions
Reset Chr6310A_reset
Self-Test Chr6310A_self_test
Revision Query Chr6310A_revision_query
Error-Query Chr6310A_error_query
Error Message Chr6310A_error_message
Error Info
Get Error Info Chr6310A_GetErrorInfo
Clear Error Info Chr6310A_ClearErrorInfo
Coercion Info
Get Next Coercion Record Chr6310A_GetNextCoercionRecord
Locking
Lock Session Chr6310A_LockSession
Unlock Session Chr6310A_UnlockSession
Instrument I/O
Write Instrument Data Chr6310A_WriteInstrData
Read Instrument Data Chr6310A_ReadInstrData
Close Chr6310A_close
________________________________________________________________________________
Programmable DC Electronic Load
This instrument driver contains programming support for the Programmable
DC Electronic Load. This driver has all the functions that IVI and
VXIplug&play require.
Note: This driver requires the VISA and IVI libraries.
________________________________________________________________________________
The following functions are in alphabetical order.
________________________________________________________________________________
Chr6310A_ABORT
Function Chr6310A_ABORT As ViStatus (ByVal instrumentHandle As ViSession)
Purpose
It sets all electronic loads to "OFF".
Parameter List
ByVal instrumentHandle As ViSession
The ViSession handle that you obtain from the C6310A_init or
C6310A_InitWithOptions function. The handle identifies a particular
instrument session.
Default Value: None
Return Value
Reports the status of this operation.
To obtain a text description of the status code, or if the status
code is not listed below, call the C63800_error_message function. To
obtain additional information about the error condition, use the
C63800_GetErrorInfo and C63800_ClearErrorInfo functions.
Status Codes:
Status Description
-------------------------------------------------
0 No error (the call was successful).
3FFF0005 The specified termination character was read.
3FFF0006 The specified number of bytes was read.
3FFC0102 Reset not supported.
BFFF0000 Miscellaneous or system error occurred.
BFFF000E Invalid session handle.
BFFF0015 Timeout occurred before operation could complete.
BFFF0034 Violation of raw write protocol occurred.
BFFF0035 Violation of raw read protocol occurred.
BFFF0036 Device reported an output protocol error.
BFFF0037 Device reported an input protocol error.
BFFF0038 Bus error occurred during transfer.
BFFF003A Invalid setup (attributes are not consistent).
BFFF005F A "no listeners" condition was detected.
BFFF0060 This interface is not the controller-in-charge.
BFFF0067 Operation is not supported on this session.
________________________________________________________________________________
Chr6310A_CheckAttributeViBoolean
Function Chr6310A_CheckAttributeViBoolean As ViStatus (ByVal instrumentHandle As ViSession, channelName As ViChar, ByVal attributeID As ViAttr, ByVal attributeValue As ViBoolean)
Purpose
This function checks the validity of a value you specify for a ViBoolean
attribute.
Parameter List
ByVal instrumentHandle As ViSession
The ViSession handle that you obtain from the Chr6310A_init or
Chr6310A_InitWithOptions function. The handle identifies a
particular instrument session.
Default Value: None
channelName As ViChar
If the attribute is channel-based, this parameter specifies the name
of the channel on which to check the attribute value. If the
attribute is not channel-based, then pass VI_NULL or an empty string.
Valid Channel Names: 1
Default Value: ""
ByVal attributeID As ViAttr
Pass the ID of an attribute.
From the function panel window, you can use this control as follows.
- Click on the control or press , , or
, to display a dialog box containing a
hierarchical list of the available attributes. Attributes
whose value cannot be set are dim. Help text is shown for
each attribute. Select an attribute by double-clicking on it
or by selecting it and then pressing .
Read-only attributes appear dim in the list box. If you
select a read-only attribute, an error message appears.
A ring control at the top of the dialog box allows you to see
all IVI attributes or only the attributes of the ViBoolean
type. If you choose to see all IVI attributes, the data types
appear to the right of the attribute names in the list box.
Attributes with data types other than ViBoolean are dim. If
you select an attribute data type that is dim, LabWindows/CVI
transfers you to the function panel for the corresponding
function that is consistent with the data type.
- If you want to enter a variable name, press to change
this ring control to a manual input box.
- If the attribute in this ring control has named constants as
valid values, you can view the constants by moving to the
Attribute Value control and pressing .
ByVal attributeValue As ViBoolean
Pass the value which you want to verify as a valid value for the
attribute.
From the function panel window, you can use this control as follows.
- If the attribute currently showing in the Attribute ID ring
control has constants as valid values, you can view a list of
the constants by pressing on this control. Select a
value by double-clicking on it or by selecting it and then
pressing .
Note: Some of the values might not be valid depending on the
current settings of the instrument session.
Default Value: none
Return Value
Reports the status of this operation.
To obtain a text description of the status code, or if the status
code is not listed below, call the Chr6310A_error_message function.
To obtain additional information about the error condition, use the
Chr6310A_GetErrorInfo and Chr6310A_ClearErrorInfo functions.
Status Codes:
Status Description
-------------------------------------------------
0 No error (the call was successful).
BFFA0001 Instrument error. Call Chr6310A_error_query.
BFFA000C Invalid attribute.
BFFA000D Attribute is not writable.
BFFA000E Attribute is not readable.
BFFA000F Invalid parameter.
BFFA0010 Invalid value.
BFFA0012 Attribute not supported.
BFFA0013 Value not supported.
BFFA0014 Invalid type.
BFFA0015 Types do not match.
BFFA0016 Attribute already has a value waiting to be updated.
BFFA0018 Not a valid configuration.
BFFA0019 Requested item does not exist or value not available.
BFFA001A Requested attribute value not known.
BFFA001B No range table.
BFFA001C Range table is invalid.
BFFA001F No channel table has been built for the session.
BFFA0020 Channel name specified is not valid.
BFFA0044 Channel name required.
BFFA0045 Channel name not allowed.
BFFA0046 Attribute not valid for channel.
BFFA0047 Attribute must be channel based.
BFFF0000 Miscellaneous or system error occurred.
BFFF000E Invalid session handle.
BFFF0015 Timeout occurred before operation could complete.
BFFF0034 Violation of raw write protocol occurred.
BFFF0035 Violation of raw read protocol occurred.
BFFF0036 Device reported an output protocol error.
BFFF0037 Device reported an input protocol error.
BFFF0038 Bus error occurred during transfer.
BFFF003A Invalid setup (attributes are not consistent).
BFFF005F A "no listeners" condition was detected.
BFFF0060 This interface is not the controller-in-charge.
BFFF0067 Operation is not supported on this session.
3FFF0085 The status value you passed is unknown.
________________________________________________________________________________
Chr6310A_CheckAttributeViInt32
Function Chr6310A_CheckAttributeViInt32 As ViStatus (ByVal instrumentHandle As ViSession, channelName As ViChar, ByVal attributeID As ViAttr, ByVal attributeValue As ViInt32)
Purpose
This function checks the validity of a value you specify for a ViInt32
attribute.
Parameter List
ByVal instrumentHandle As ViSession
The ViSession handle that you obtain from the Chr6310A_init or
Chr6310A_InitWithOptions function. The handle identifies a
particular instrument session.
Default Value: None
channelName As ViChar
If the attribute is channel-based, this parameter specifies the name
of the channel on which to check the attribute value. If the
attribute is not channel-based, then pass VI_NULL or an empty string.
Valid Channel Names: 1
Default Value: ""
ByVal attributeID As ViAttr
Pass the ID of an attribute.
From the function panel window, you can use this control as follows.
- Click on the control or press , , or
, to display a dialog box containing a
hierarchical list of the available attributes. Attributes
whose value cannot be set are dim. Help text is shown for
each attribute. Select an attribute by double-clicking on it
or by selecting it and then pressing .
Read-only attributes appear dim in the list box. If you
select a read-only attribute, an error message appears.
A ring control at the top of the dialog box allows you to see
all IVI attributes or only the attributes of the ViInt32 type.
If you choose to see all IVI attributes, the data types appear
to the right of the attribute names in the list box.
Attributes with data types other than ViInt32 are dim. If
you select an attribute data type that is dim, LabWindows/CVI
transfers you to the function panel for the corresponding
function that is consistent with the data type.
- If you want to enter a variable name, press to change
this ring control to a manual input box.
- If the attribute in this ring control has named constants as
valid values, you can view the constants by moving to the
Attribute Value control and pressing .
ByVal attributeValue As ViInt32
Pass the value which you want to verify as a valid value for the
attribute.
From the function panel window, you can use this control as follows.
- If the attribute currently showing in the Attribute ID ring
control has constants as valid values, you can view a list of
the constants by pressing on this control. Select a
value by double-clicking on it or by selecting it and then
pressing .
Note: Some of the values might not be valid depending on the
current settings of the instrument session.
Default Value: none
Return Value
Reports the status of this operation.
To obtain a text description of the status code, or if the status
code is not listed below, call the Chr6310A_error_message function.
To obtain additional information about the error condition, use the
Chr6310A_GetErrorInfo and Chr6310A_ClearErrorInfo functions.
Status Codes:
Status Description
-------------------------------------------------
0 No error (the call was successful).
BFFA0001 Instrument error. Call Chr6310A_error_query.
BFFA000C Invalid attribute.
BFFA000D Attribute is not writable.
BFFA000E Attribute is not readable.
BFFA000F Invalid parameter.
BFFA0010 Invalid value.
BFFA0012 Attribute not supported.
BFFA0013 Value not supported.
BFFA0014 Invalid type.
BFFA0015 Types do not match.
BFFA0016 Attribute already has a value waiting to be updated.
BFFA0018 Not a valid configuration.
BFFA0019 Requested item does not exist or value not available.
BFFA001A Requested attribute value not known.
BFFA001B No range table.
BFFA001C Range table is invalid.
BFFA001F No channel table has been built for the session.
BFFA0020 Channel name specified is not valid.
BFFA0044 Channel name required.
BFFA0045 Channel name not allowed.
BFFA0046 Attribute not valid for channel.
BFFA0047 Attribute must be channel based.
BFFF0000 Miscellaneous or system error occurred.
BFFF000E Invalid session handle.
BFFF0015 Timeout occurred before operation could complete.
BFFF0034 Violation of raw write protocol occurred.
BFFF0035 Violation of raw read protocol occurred.
BFFF0036 Device reported an output protocol error.
BFFF0037 Device reported an input protocol error.
BFFF0038 Bus error occurred during transfer.
BFFF003A Invalid setup (attributes are not consistent).
BFFF005F A "no listeners" condition was detected.
BFFF0060 This interface is not the controller-in-charge.
BFFF0067 Operation is not supported on this session.
3FFF0085 The status value you passed is unknown.
________________________________________________________________________________
Chr6310A_CheckAttributeViReal64
Function Chr6310A_CheckAttributeViReal64 As ViStatus (ByVal instrumentHandle As ViSession, channelName As ViChar, ByVal attributeID As ViAttr, ByVal attributeValue As ViReal64)
Purpose
This function checks the validity of a value you specify for a ViReal64
attribute.
Parameter List
ByVal instrumentHandle As ViSession
The ViSession handle that you obtain from the Chr6310A_init or
Chr6310A_InitWithOptions function. The handle identifies a
particular instrument session.
Default Value: None
channelName As ViChar
If the attribute is channel-based, this parameter specifies the name
of the channel on which to check the attribute value. If the
attribute is not channel-based, then pass VI_NULL or an empty string.
Valid Channel Names: 1
Default Value: ""
ByVal attributeID As ViAttr
Pass the ID of an attribute.
From the function panel window, you can use this control as follows.
- Click on the control or press , , or
, to display a dialog box containing a
hierarchical list of the available attributes. Attributes
whose value cannot be set are dim. Help text is shown for
each attribute. Select an attribute by double-clicking on it
or by selecting it and then pressing .
Read-only attributes appear dim in the list box. If you
select a read-only attribute, an error message appears.
A ring control at the top of the dialog box allows you to see
all IVI attributes or only the attributes of the ViReal64
type. If you choose to see all IVI attributes, the data types
appear to the right of the attribute names in the list box.
Attributes with data types other than ViReal64 are dim. If
you select an attribute data type that is dim, LabWindows/CVI
transfers you to the function panel for the corresponding
function that is consistent with the data type.
- If you want to enter a variable name, press to change
this ring control to a manual input box.
- If the attribute in this ring control has named constants as
valid values, you can view the constants by moving to the
Attribute Value control and pressing .
ByVal attributeValue As ViReal64
Pass the value which you want to verify as a valid value for the
attribute.
From the function panel window, you can use this control as follows.
- If the attribute currently showing in the Attribute ID ring
control has constants as valid values, you can view a list of
the constants by pressing on this control. Select a
value by double-clicking on it or by selecting it and then
pressing .
Note: Some of the values might not be valid depending on the
current settings of the instrument session.
Default Value: none
Return Value
Reports the status of this operation.
To obtain a text description of the status code, or if the status
code is not listed below, call the Chr6310A_error_message function.
To obtain additional information about the error condition, use the
Chr6310A_GetErrorInfo and Chr6310A_ClearErrorInfo functions.
Status Codes:
Status Description
-------------------------------------------------
0 No error (the call was successful).
BFFA0001 Instrument error. Call Chr6310A_error_query.
BFFA000C Invalid attribute.
BFFA000D Attribute is not writable.
BFFA000E Attribute is not readable.
BFFA000F Invalid parameter.
BFFA0010 Invalid value.
BFFA0012 Attribute not supported.
BFFA0013 Value not supported.
BFFA0014 Invalid type.
BFFA0015 Types do not match.
BFFA0016 Attribute already has a value waiting to be updated.
BFFA0018 Not a valid configuration.
BFFA0019 Requested item does not exist or value not available.
BFFA001A Requested attribute value not known.
BFFA001B No range table.
BFFA001C Range table is invalid.
BFFA001F No channel table has been built for the session.
BFFA0020 Channel name specified is not valid.
BFFA0044 Channel name required.
BFFA0045 Channel name not allowed.
BFFA0046 Attribute not valid for channel.
BFFA0047 Attribute must be channel based.
BFFF0000 Miscellaneous or system error occurred.
BFFF000E Invalid session handle.
BFFF0015 Timeout occurred before operation could complete.
BFFF0034 Violation of raw write protocol occurred.
BFFF0035 Violation of raw read protocol occurred.
BFFF0036 Device reported an output protocol error.
BFFF0037 Device reported an input protocol error.
BFFF0038 Bus error occurred during transfer.
BFFF003A Invalid setup (attributes are not consistent).
BFFF005F A "no listeners" condition was detected.
BFFF0060 This interface is not the controller-in-charge.
BFFF0067 Operation is not supported on this session.
3FFF0085 The status value you passed is unknown.
________________________________________________________________________________
Chr6310A_CheckAttributeViSession
Function Chr6310A_CheckAttributeViSession As ViStatus (ByVal instrumentHandle As ViSession, channelName As ViChar, ByVal attributeID As ViAttr, ByVal attributeValue As ViSession)
Purpose
This function checks the validity of a value you specify for a ViSession
attribute.
Parameter List
ByVal instrumentHandle As ViSession
The ViSession handle that you obtain from the Chr6310A_init or
Chr6310A_InitWithOptions function. The handle identifies a
particular instrument session.
Default Value: None
channelName As ViChar
If the attribute is channel-based, this parameter specifies the name
of the channel on which to check the attribute value. If the
attribute is not channel-based, then pass VI_NULL or an empty string.
Valid Channel Names: 1
Default Value: ""
ByVal attributeID As ViAttr
Pass the ID of an attribute.
From the function panel window, you can use this control as follows.
- Click on the control or press , , or
, to display a dialog box containing a
hierarchical list of the available attributes. Attributes
whose value cannot be set are dim. Help text is shown for
each attribute. Select an attribute by double-clicking on it
or by selecting it and then pressing .
Read-only attributes appear dim in the list box. If you
select a read-only attribute, an error message appears.
A ring control at the top of the dialog box allows you to see
all IVI attributes or only the attributes of the ViSession
type. If you choose to see all IVI attributes, the data types
appear to the right of the attribute names in the list box.
Attributes with data types other than ViSession are dim. If
you select an attribute data type that is dim, LabWindows/CVI
transfers you to the function panel for the corresponding
function that is consistent with the data type.
- If you want to enter a variable name, press to change
this ring control to a manual input box.
- If the attribute in this ring control has named constants as
valid values, you can view the constants by moving to the
Attribute Value control and pressing .
ByVal attributeValue As ViSession
Pass the value which you want to verify as a valid value for the
attribute.
From the function panel window, you can use this control as follows.
- If the attribute currently showing in the Attribute ID ring
control has constants as valid values, you can view a list of
the constants by pressing on this control. Select a
value by double-clicking on it or by selecting it and then
pressing .
Note: Some of the values might not be valid depending on the
current settings of the instrument session.
Default Value: none
Return Value
Reports the status of this operation.
To obtain a text description of the status code, or if the status
code is not listed below, call the Chr6310A_error_message function.
To obtain additional information about the error condition, use the
Chr6310A_GetErrorInfo and Chr6310A_ClearErrorInfo functions.
Status Codes:
Status Description
-------------------------------------------------
0 No error (the call was successful).
BFFA0001 Instrument error. Call Chr6310A_error_query.
BFFA000C Invalid attribute.
BFFA000D Attribute is not writable.
BFFA000E Attribute is not readable.
BFFA000F Invalid parameter.
BFFA0010 Invalid value.
BFFA0012 Attribute not supported.
BFFA0013 Value not supported.
BFFA0014 Invalid type.
BFFA0015 Types do not match.
BFFA0016 Attribute already has a value waiting to be updated.
BFFA0018 Not a valid configuration.
BFFA0019 Requested item does not exist or value not available.
BFFA001A Requested attribute value not known.
BFFA001B No range table.
BFFA001C Range table is invalid.
BFFA001F No channel table has been built for the session.
BFFA0020 Channel name specified is not valid.
BFFA0044 Channel name required.
BFFA0045 Channel name not allowed.
BFFA0046 Attribute not valid for channel.
BFFA0047 Attribute must be channel based.
BFFF0000 Miscellaneous or system error occurred.
BFFF000E Invalid session handle.
BFFF0015 Timeout occurred before operation could complete.
BFFF0034 Violation of raw write protocol occurred.
BFFF0035 Violation of raw read protocol occurred.
BFFF0036 Device reported an output protocol error.
BFFF0037 Device reported an input protocol error.
BFFF0038 Bus error occurred during transfer.
BFFF003A Invalid setup (attributes are not consistent).
BFFF005F A "no listeners" condition was detected.
BFFF0060 This interface is not the controller-in-charge.
BFFF0067 Operation is not supported on this session.
3FFF0085 The status value you passed is unknown.
________________________________________________________________________________
Chr6310A_CheckAttributeViString
Function Chr6310A_CheckAttributeViString As ViStatus (ByVal instrumentHandle As ViSession, channelName As ViChar, ByVal attributeID As ViAttr, attributeValue As ViChar)
Purpose
This function checks the validity of a value you specify for a ViString
attribute.
Parameter List
ByVal instrumentHandle As ViSession
The ViSession handle that you obtain from the Chr6310A_init or
Chr6310A_InitWithOptions function. The handle identifies a
particular instrument session.
Default Value: None
channelName As ViChar
If the attribute is channel-based, this parameter specifies the name
of the channel on which to check the attribute value. If the
attribute is not channel-based, then pass VI_NULL or an empty string.
Valid Channel Names: 1
Default Value: ""
ByVal attributeID As ViAttr
Pass the ID of an attribute.
From the function panel window, you can use this control as follows.
- Click on the control or press , , or
, to display a dialog box containing a
hierarchical list of the available attributes. Attributes
whose value cannot be set are dim. Help text is shown for
each attribute. Select an attribute by double-clicking on it
or by selecting it and then pressing .
Read-only attributes appear dim in the list box. If you
select a read-only attribute, an error message appears.
A ring control at the top of the dialog box allows you to see
all IVI attributes or only the attributes of the ViString
type. If you choose to see all IVI attributes, the data types
appear to the right of the attribute names in the list box.
Attributes with data types other than ViString are dim. If
you select an attribute data type that is dim, LabWindows/CVI
transfers you to the function panel for the corresponding
function that is consistent with the data type.
- If you want to enter a variable name, press to change
this ring control to a manual input box.
- If the attribute in this ring control has named constants as
valid values, you can view the constants by moving to the
Attribute Value control and pressing .
attributeValue As ViChar
Pass the value which you want to verify as a valid value for the
attribute.
From the function panel window, you can use this control as follows.
- If the attribute currently showing in the Attribute ID ring
control has constants as valid values, you can view a list of
the constants by pressing on this control. Select a
value by double-clicking on it or by selecting it and then
pressing .
Note: Some of the values might not be valid depending on the
current settings of the instrument session.
Default Value: none
Return Value
Reports the status of this operation.
To obtain a text description of the status code, or if the status
code is not listed below, call the Chr6310A_error_message function.
To obtain additional information about the error condition, use the
Chr6310A_GetErrorInfo and Chr6310A_ClearErrorInfo functions.
Status Codes:
Status Description
-------------------------------------------------
0 No error (the call was successful).
BFFA0001 Instrument error. Call Chr6310A_error_query.
BFFA000C Invalid attribute.
BFFA000D Attribute is not writable.
BFFA000E Attribute is not readable.
BFFA000F Invalid parameter.
BFFA0010 Invalid value.
BFFA0012 Attribute not supported.
BFFA0013 Value not supported.
BFFA0014 Invalid type.
BFFA0015 Types do not match.
BFFA0016 Attribute already has a value waiting to be updated.
BFFA0018 Not a valid configuration.
BFFA0019 Requested item does not exist or value not available.
BFFA001A Requested attribute value not known.
BFFA001B No range table.
BFFA001C Range table is invalid.
BFFA001F No channel table has been built for the session.
BFFA0020 Channel name specified is not valid.
BFFA0044 Channel name required.
BFFA0045 Channel name not allowed.
BFFA0046 Attribute not valid for channel.
BFFA0047 Attribute must be channel based.
BFFF0000 Miscellaneous or system error occurred.
BFFF000E Invalid session handle.
BFFF0015 Timeout occurred before operation could complete.
BFFF0034 Violation of raw write protocol occurred.
BFFF0035 Violation of raw read protocol occurred.
BFFF0036 Device reported an output protocol error.
BFFF0037 Device reported an input protocol error.
BFFF0038 Bus error occurred during transfer.
BFFF003A Invalid setup (attributes are not consistent).
BFFF005F A "no listeners" condition was detected.
BFFF0060 This interface is not the controller-in-charge.
BFFF0067 Operation is not supported on this session.
3FFF0085 The status value you passed is unknown.
________________________________________________________________________________
Chr6310A_ClearErrorInfo
Function Chr6310A_ClearErrorInfo As ViStatus (ByVal instrumentHandle As ViSession)
Purpose
This function clears the error information for the current execution
thread and the IVI session you specify. If you pass VI_NULL for the
Instrument Handle parameter, this function clears the error information
only for the current execution thread.
The error information includes a primary error code, secondary error
code, and an error elaboration string. For a particular session, this
information is the same as the values held in the following attributes:
CHR6310A_ATTR_PRIMARY_ERROR
CHR6310A_ATTR_SECONDARY_ERROR
CHR6310A_ATTR_ERROR_ELABORATION
This function sets the primary and secondary error codes to VI_SUCCESS
(0), and sets the error elaboration string to "".
The IVI Library also maintains this error information separately for each
thread. This is useful if you do not have a session handle to pass to
Chr6310A_ClearErrorInfo or Chr6310A_GetErrorInfo, which occurs when a
call to Chr6310A_init or Chr6310A_InitWithOptions fails.
Parameter List
ByVal instrumentHandle As ViSession
The ViSession handle that you obtain from the Chr6310A_init or
Chr6310A_InitWithOptions function. The handle identifies a
particular instrument session.
Default Value: None
Return Value
Reports the status of this operation.
This function returns a non-zero status code only when it is unable
to clear the error information for the session or thread. The
function can return the following status codes:
Status Description
-------------------------------------------------
0 No error (the call was successful).
BFFF000E Invalid session handle.
________________________________________________________________________________
Chr6310A_close
Function Chr6310A_close As ViStatus (ByVal instrumentHandle As ViSession)
Purpose
This function performs the following operations:
- Closes the instrument I/O session.
- Destroys the instrument driver session and all of its attributes.
- Deallocates any memory resources the driver uses.
Notes:
(1) You must unlock the session before calling Chr6310A_close.
(2) After calling Chr6310A_close, you cannot use the instrument driver
again until you call Chr6310A_init or Chr6310A_InitWithOptions.
Parameter List
ByVal instrumentHandle As ViSession
The ViSession handle that you obtain from the Chr6310A_init or
Chr6310A_InitWithOptions function. The handle identifies a
particular instrument session.
Default Value: None
Return Value
Reports the status of this operation.
To obtain a text description of the status code, or if the status
code is not listed below, call the Chr6310A_error_message function.
To obtain additional information about the error condition, use the
Chr6310A_GetErrorInfo and Chr6310A_ClearErrorInfo functions.
Status Codes:
Status Description
-------------------------------------------------
0 No error (the call was successful).
3FFF0005 The specified termination character was read.
3FFF0006 The specified number of bytes was read.
BFFF0000 Miscellaneous or system error occurred.
BFFF000E Invalid session handle.
BFFF0015 Timeout occurred before operation could complete.
BFFF0034 Violation of raw write protocol occurred.
BFFF0035 Violation of raw read protocol occurred.
BFFF0036 Device reported an output protocol error.
BFFF0037 Device reported an input protocol error.
BFFF0038 Bus error occurred during transfer.
BFFF003A Invalid setup (attributes are not consistent).
BFFF005F A "no listeners" condition was detected.
BFFF0060 This interface is not the controller-in-charge.
BFFF0067 Operation is not supported on this session.
________________________________________________________________________________
Chr6310A_CLS
Function Chr6310A_CLS As ViStatus (ByVal instrumentHandle As ViSession)
Purpose
This command clears the following registers
1. Channel Status Event registers for all channels
2. Channel Summary Event register
3. Questionable Status Event register
4. Standard Event Status Event register
5. Operation Status Event register
Parameter List
ByVal instrumentHandle As ViSession
The ViSession handle that you obtain from the C6310A_init or
C6310A_InitWithOptions function. The handle identifies a particular
instrument session.
Default Value: None
Return Value
Reports the status of this operation.
To obtain a text description of the status code, or if the status
code is not listed below, call the C63800_error_message function. To
obtain additional information about the error condition, use the
C63800_GetErrorInfo and C63800_ClearErrorInfo functions.
Status Codes:
Status Description
-------------------------------------------------
0 No error (the call was successful).
3FFF0005 The specified termination character was read.
3FFF0006 The specified number of bytes was read.
3FFC0102 Reset not supported.
BFFF0000 Miscellaneous or system error occurred.
BFFF000E Invalid session handle.
BFFF0015 Timeout occurred before operation could complete.
BFFF0034 Violation of raw write protocol occurred.
BFFF0035 Violation of raw read protocol occurred.
BFFF0036 Device reported an output protocol error.
BFFF0037 Device reported an input protocol error.
BFFF0038 Bus error occurred during transfer.
BFFF003A Invalid setup (attributes are not consistent).
BFFF005F A "no listeners" condition was detected.
BFFF0060 This interface is not the controller-in-charge.
BFFF0067 Operation is not supported on this session.
________________________________________________________________________________
Chr6310A_error_message
Function Chr6310A_error_message As ViStatus (ByVal instrumentHandle As ViSession, ByVal errorCode As ViStatus, errorMessage As ViChar)
Purpose
This function converts a status code returned by an instrument driver
function into a user-readable string.
Parameter List
ByVal instrumentHandle As ViSession
The ViSession handle that you obtain from the Chr6310A_init or
Chr6310A_InitWithOptions function. The handle identifies a
particular instrument session.
You can pass VI_NULL for this parameter. This is useful when one of
the initialize functions fail.
Default Value: VI_NULL
ByVal errorCode As ViStatus
Pass the Status parameter that is returned from any of the instrument
driver functions.
Default Value: 0 (VI_SUCCESS)
errorMessage As ViChar
Returns the user-readable message string that corresponds to the
status code you specify.
You must pass a ViChar array with at least 256 bytes.
Return Value
Reports the status of this operation.
This function can return only three possible status codes:
Status Description
-------------------------------------------------
0 No error (the call was successful).