Ivi.Driver.Interop IVI Driver root interface Opens the I/O session to the instrument. Driver methods and properties that access the instrument are only accessible after Initialize is called. Initialize optionally performs a Reset and queries the instrument to validate the instrument model. An IVI logical name or an instrument specific string that identifies the address of the instrument, such as a VISA resource descriptor string. Specifies whether to verify the ID of the instrument. Specifies whether to reset the instrument. The user can use the OptionsString parameter to specify the initial values of certain IVI inherent attributes for the session. The format of an assignment in the OptionsString parameter is "Name=Value", where Name is one of: RangeCheck, QuerytInstrStatus, Cache, Simulate, RecordCoercions, InterchangeCheck, or DriverSetup. Value is either true or false except for DriverSetup. If the Options String parameter contains an assignment for the Driver Setup attribute, the Initialize function assumes that everything following "DriverSetup=" is part of the assignment. Closes the I/O session to the instrument. Driver methods and properties that access the instrument are not accessible after Close is called. Pointer to the IIviDriverOperation interface Pointer to the IIviDriverIdentity interface Pointer to the IIviDriverUtility interface Initialized is True between a successful call to the Initialize method and a successful call to the Close method, and False at all other times. IVI Driver operation interface Invalidates all of the driver's cached values. Clears the list of interchangeability warnings that the IVI specific driver maintains. Returns the oldest warning from the interchange warning list. Records are only added to the list if InterchangeCheck is True. A string describing the oldest interchangeability warning or empty string if no warrnings remain. Resets the interchangeability checking algorithms of the driver so that methods and properties that executed prior to calling this function have no affect on whether future calls to the driver generate interchangeability warnings. Returns the oldest record from the coercion record list. Records are only added to the list if RecordCoercions is True. The coercion record string shall contain the following information: (1) The name of the attribute that was coerced. This can be the generic name, the COM property name, or the C defined constant. (2) If the attribute is channel-based, the name of the channel. The channel name can be the specific driver channel string or the virtual channel name that the user specified. (3) If the attribute applies to a repeated capability, the name of the repeated capability. The name can be the specific driver repeated capability token or the virtual repeated capability name that the user specified. (4) The value that the user specified for the attribute. (5) The value to which the attribute was coerced. Logical Name identifies a driver session in the Configuration Store. If Logical Name is not empty, the driver was initialized from information in the driver session. If it is empty, the driver was initialized without using the Configuration Store. The resource descriptor specifies the connection to a physical device. It is either specified in the Configuration Store or passed in the ResourceName parameter of the Initialize function. It is empty if the driver is not initialized. Drivers may choose to always cache some instrument settings, never cache others, and optionally cache others, to avoid unecessary I/O to the instrument. If True, the driver caches optionally cached instrument settings. If True, the driver maintains a record of interchangeability warnings. If the driver does not support interchangeability checking, attempts to set InterchangeCheck to True return an error. If True, the driver queries the instrument status at the end of each method or property that performs I/O to the instrument. If an error is reported, use ErrorQuery to retrieve error messages one at a time from the instrument. Drivers may choose to always validate some property/parameter values, never validate others, and optionally validate others, to avoid sending invalid commands to the instrument. If True, the driver performs optional validations. If True, the driver keeps a list of the value coercions it makes for ViInt32 and ViReal64 attributes. If the driver does not support coercion recording, attempts to set RecordCoercions to True will return an error. If True, the driver does not perform I/O to the instrument, and returns simulated values for output parameters. The driver setup string. It is either specified in the Configuration Store or passed in the OptionString parameter of the Initialize function. Driver setup is empty if the driver is not initialized. IVI Driver identity interface A brief description of the implementing component. Description is limted to 256 bytes. The revision of the implementing component. Refer to IVI 3.2, Section 3.1.2.2, for a description of revision syntax and semantics. Revision is limited to 256 bytes. The name of the vendor that supplies the implementing component. Vendor is limited to 256 bytes. The name of the manufacturer reported by the physical instrument. If Simulation is enabled or the instrument is not capable of reporting the name of the manufacturer, a string is returned that explains the condition. Manufacturer is limited to 256 bytes The model number or name reported by the physical instrument. If Simulation is enabled or the instrument is not capable of reporting the model number or name, a string is returned that explains the condition. Model is limited to 256 bytes The firmware revision reported by the physical instrument. If Simulation is enabled or the instrument is not capable of reporting the firmware revision, a string is returned that explains the condition. The case-sensitive unique identifier of the implementing IVI-COM instrument driver. A comma-separated list of instrument models that the IVI specific driver can control. The string does not include an abbreviation for the manufacturer if it is the same for all models. For IVI class-compliant drivers, the major version number of the instrument class specification. If the driver is not class compliant, the driver returns zero. For IVI class-compliant drivers, the minor version number of the instrument class specification. If the driver is not class compliant, the driver returns zero. A comma-separated list of the class capability groups implemented by the driver. Capability group names are documented in the IVI class specifications. If the driver is not class compliant, the driver returns an empty string. IVI Driver component identity interface A brief description of the implementing component. Description is limted to 256 bytes. The revision of the implementing component. Refer to IVI 3.2, Section 3.1.2.2, for a description of revision syntax and semantics. Revision is limited to 256 bytes. The name of the vendor that supplies the implementing component. Vendor is limited to 256 bytes. IVI Driver utility interface Places the instrument in a known state and configures instrument options on which the IVI specific driver depends (for example, enabling/disabling headers). For an IEEE 488.2 instrument, Reset sends the command string *RST to the instrument. Does the equivalent of Reset and then, (1) disables class extension capability groups, (2) sets attributes to initial values defined by class specs, and (3) configures the driver to option string settings used when Initialize was last executed. Quickly places the instrument in a state where it has no, or minimal, effect on the external system to which it is connected. This state is not necessarily a known state. Performs an instrument self test, waits for the instrument to complete the test, and queries the instrument for the results. If the instrument passes the test, TestResult is zero and TestMessage is 'Self test passed'. The numeric result from the self test operation. 0 = no error (test passed) The self test status message Queries the instrument and returns instrument specific error information. This function can be used when QueryInstrumentStatus is True to retrieve error details when the driver detects an instrument error. Instrument error code Instrument error message Obtains a multithread lock on the driver after waiting until all other execution threads have released their locks on the instrument session. Releases a previously obtained mutlithread lock. IVI Driver class identity interface The location of the IVI specific driver instantiated by the implementing class driver. It can be a COM class ID or DLL pathname, depending on the specific driver. If a specific driver has not been instantiated, the class driver returns an empty string. IVI Driver class wrapper interface Binds a COM wrapper object to an existing IVI-C specific driver session. Unique identifier for an IVI session. The C session handle that the COM wrapper is currently using to communicate with an IVI-C specific driver. IVI Driver (inherent features) defined HRESULTS Success Unrecoverable failure Instrument error detected File could not be opened File could not be read File could not be written The path name is invalid Invalid value for parameter or property Method not supported Property not supported The enumeration value for the parameter is not supported A connection to the instrument has not been initialized Channel or repeated capability name specified is not valid for the instrument. Too many files opened Channel or repeated capability name required The option string contains an entry without a name. The option string contains an entry without a value. The option string contains an entry with an unknown option name. The option string contains an entry with an unknown option value. The necessary memory could not be allocated Operation in progress Null pointer passed for parameter or property Unexpected response from the instrument File not found The file format is invalid The instrument status is not available Instrument ID query failed Instrument reset failed Insufficient location information or resource not present in the system. The driver is already initialized The simulation state cannot be changed. The repeated capability selector is badly-formed. The number of levels in the selector is not valid for the repeated capability. The range is not valid for the repeated capability. Unknown name in selector. Unknown physical repeated capability selector. Identification query not supported Reset operation not supported Self test operation not supported Error query operation not supported Revision query not supported