Ivi.ConfigServer.Interop
IIviLogicalNameCollection Interface
Same as IIviLogicalNameCollection Interface
Adds an IviLogicalName object to the global Logical Name collection.
The IviLogicalName object to be added.
Removes an IviLogicalName object from the global Logical Name collection.
The name or one-based index of the Logical Name to be removed.
The number of IviLogicalName objects in the global Logical Name collection.
A read-only property that gets an IviLogicalName object from the global Logical Name collection.
The name or one-based index of the Logical Name to be retrieved.
The indexer for the class gets an IviLogicalName object from the global Logical Name collection.
The parameter is the name or one-based index of the Logical Name to be retrieved.
The name or one-based index of the Logical Name to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviLogicalName type.
An IEnumerator for the LogicalNameCollection.
IviLogicalNameCollectionClass object
IviLogicalNameCollectionClass object constructor
Adds an IviLogicalName object to the global Logical Name collection.
The IviLogicalName object to be added.
Removes an IviLogicalName object from the global Logical Name collection.
The name or one-based index of the Logical Name to be removed.
The number of IviLogicalName objects in the global Logical Name collection.
A read-only property that gets an IviLogicalName object from the global Logical Name collection.
The name or one-based index of the Logical Name to be retrieved.
The indexer for the class gets an IviLogicalName object from the global Logical Name collection.
The parameter is the name or one-based index of the Logical Name to be retrieved.
The name or one-based index of the Logical Name to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviLogicalName type.
An IEnumerator for the LogicalNameCollection.
IIviLogicalName Interface
Same as IIviLogicalName Interface
The name for the IviLogicalName object. An empty string is not a legal value.
The description of the IviLogicalName object.The empty string is a legal value for this property.
The IVI Session to which the logical name refers. The IVI Session may be an IVI Driver Session.
IviLogicalNameClass object
IviLogicalNameClass object constructor
The name for the IviLogicalName object. An empty string is not a legal value.
The description of the IviLogicalName object.The empty string is a legal value for this property.
The IVI Session to which the logical name refers. The IVI Session may be an IVI Driver Session.
IIviSession Interface
Same as IIviSession Interface
The session's name. An empty string is not a legal value.
The description of the IviSession object.The empty string is a legal value for this property.
References a collection of DataComponents that modifies the object of which the
collection is a part.
References the Hardware Asset used by the Session.
References a collection of all the IVI Virtual Name objects used
by the Session. Within a collection, the Name property uniquely identifies an IVI Virtual
name object. IVI Virtual Name objects cannot be reused between sessions.
References the Software Module configured by the Session.
The name of the current or most recently referenced software module referenced by the
Software Module property.
IviSessionClass object
IviSessionClass object constructor
The session's name. An empty string is not a legal value.
The description of the IviSession object.The empty string is a legal value for this property.
References a collection of DataComponents that modifies the object of which the
collection is a part.
References the Hardware Asset used by the Session.
References a collection of all the IVI Virtual Name objects used
by the Session. Within a collection, the Name property uniquely identifies an IVI Virtual
name object. IVI Virtual Name objects cannot be reused between sessions.
References the Software Module configured by the Session.
The name of the current or most recently referenced software module referenced by the
Software Module property.
IIviDataComponentCollection Interface
Same as IIviDataComponentCollection Interface
Adds an IviDataComponent object to the Data Component collection.
The IviDataComponent object to be added.
Removes an IviDataComponent object from the Data Component collection.
The name or one-based index of the Data Component to be removed.
The number of IviDataComponents objects in the Data Components collection
A read-only property that gets an IviDataComponent object from the Data Component collection.
The name or one-based index of the Data Component to be retrieved.
The indexer for the class gets an IviDataComponent object from the Data Component collection.
The parameter is the name or one-based index of the Data Component to be retrieved.
The name or one-based index of the Data Component to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviDataComponent type.
An IEnumerator for the DataComponentCollection.
IviDataComponentCollectionClass object
IviDataComponentCollectionClass object constructor
Adds an IviDataComponent object to the Data Component collection.
The IviDataComponent object to be added.
Removes an IviDataComponent object from the Data Component collection.
The name or one-based index of the Data Component to be removed.
The number of IviDataComponents objects in the Data Components collection
A read-only property that gets an IviDataComponent object from the Data Component collection.
The name or one-based index of the Data Component to be retrieved.
The indexer for the class gets an IviDataComponent object from the Data Component collection.
The parameter is the name or one-based index of the Data Component to be retrieved.
The name or one-based index of the Data Component to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviDataComponent type.
An IEnumerator for the DataComponentCollection.
IIviDataComponent Interface
The name for the IviDataComponent object. An empty string is not a legal value.
The description of the IviDataComponent object.The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
IIviHardwareAsset Interface
Same as IIviHardwareAsset Interface
The name for the IviHardwareAsset object. An empty string is not a legal value.
The description of the IviHardwareAsset object.The empty string is a legal value for this property.
I/O Resource Descriptor stores a string that specifies the address of the hardware
asset that can be recognized by I/O used by a software module that will access
the hardware. The empty string is a legal value for this property.
A collection of Data components that documents the hardware asset.
These data components shall have Software Module Key equal to the empty
string and Used In Session equal to None since they are not used to configure a software module.
IviHardwareAssetClass object
IviHardwareAssetClass object constructor
The name for the IviHardwareAsset object. An empty string is not a legal value.
The description of the IviHardwareAsset object.The empty string is a legal value for this property.
I/O Resource Descriptor stores a string that specifies the address of the hardware
asset that can be recognized by I/O used by a software module that will access
the hardware. The empty string is a legal value for this property.
A collection of Data components that documents the hardware asset.
These data components shall have Software Module Key equal to the empty
string and Used In Session equal to None since they are not used to configure a software module.
IIviVirtualNameCollection Interface
Same as IIviVirtualNameCollection Interface
Adds an IviVirtualName object to Virutual Name collection.
The IviVirtualName object to be added.
Removes an IviVirtualName object from the Virtual Name collection.
The name or one-based index of the Virtual Name to be removed.
The number of IviVirtualName objects in the Virtual Name collection.
A read-only property that gets an IviVirtualName object from the Virtual Name collection.
The indexer for the class gets an IviVirtualName object from the Virtual Name collection.
The parameter is the name or one-based index of the Virtual Name to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviVirtualName type.
An IEnumerator for the DataComponentCollection.
The indexer for the class gets an IviVirtualName object from the Virtual Name collection.
The parameter is the name or one-based index of the Virtual Name to be retrieved.
The name or one-based index of the Virtual Name to be retrieved.
IviVirtualNameCollectionClass object
IviVirtualNameCollectionClass object constructor
Adds an IviVirtualName object to Virutual Name collection.
The IviVirtualName object to be added.
Removes an IviVirtualName object from the Virtual Name collection.
The name or one-based index of the Virtual Name to be removed.
The number of IviVirtualName objects in the Virtual Name collection.
A read-only property that gets an IviVirtualName object from the Virtual Name collection.
The indexer for the class gets an IviVirtualName object from the Virtual Name collection.
The parameter is the name or one-based index of the Virtual Name to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviVirtualName type.
An IEnumerator for the DataComponentCollection.
The indexer for the class gets an IviVirtualName object from the Virtual Name collection.
The parameter is the name or one-based index of the Virtual Name to be retrieved.
The name or one-based index of the Virtual Name to be retrieved.
IIviVirtualName Interface
Same as IIviVirtualName Interface
The name for the IviVirtualName object. An empty string is not a legal value.
A string used to replace the virtual identifier when the virtual
identifier is used to specify repeated capability instances in a software
module. When the software module
encounters the associated virtual identifier in a repeated capability selector,
it substitutes the Map To string for the virtual identifier.
The empty string is a legal value for this property only if the
IVI Virtual Name object references a non-empty collection of IVI
Virtual Range objects.
A collection of IVI Virtual Range objects used to qualify the referencing IVI
Virtual Name object.
IviVirtualNameClass object
IviVirtualNameClass object constructor
The name for the IviVirtualName object. An empty string is not a legal value.
A string used to replace the virtual identifier when the virtual
identifier is used to specify repeated capability instances in a software
module. When the software module
encounters the associated virtual identifier in a repeated capability selector,
it substitutes the Map To string for the virtual identifier.
The empty string is a legal value for this property only if the
IVI Virtual Name object references a non-empty collection of IVI
Virtual Range objects.
A collection of IVI Virtual Range objects used to qualify the referencing IVI
Virtual Name object.
IIviVirtualRangeCollection Interface
Same as IIviVirtualRangeCollection Interface
Adds an IviVirtualRange object to the Virtual Range collection.
The IviVirtualRange object to be added.
Removes an IviVirtualRange object from the Virtual Range collection.
The name or one-based index of the Virtual Range to be removed.
The number of IviVirtualRange objects in the Virtual Range collection.
A read-only property that gets an IviVirtualRange object from the Virtual Range collection.
The name or one-based index of the Virtual Range to be retrieved.
The indexer for the class gets an IviVirtualRange object from the Virtual Range collection.
The parameter is the name or one-based index of the Virtual Range to be retrieved.
The name or one-based index of the Virtual Range to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviVirtualRange type.
An IEnumerator for the VirtualRangeCollection.
The indexer for the class gets an IviVirtualName object from the Virtual Range collection.
The parameter is the name or one-based index of the Virtual Range to be retrieved.
The name or one-based index of the Virtual Range to be retrieved.
IviVirtualRangeCollectionClass object
IviVirtualRangeCollectionClass object constructor
Adds an IviVirtualRange object to the Virtual Range collection.
The IviVirtualRange object to be added.
Removes an IviVirtualRange object from the Virtual Range collection.
The name or one-based index of the Virtual Range to be removed.
The number of IviVirtualRange objects in the Virtual Range collection.
A read-only property that gets an IviVirtualRange object from the Virtual Range collection.
The name or one-based index of the Virtual Range to be retrieved.
The indexer for the class gets an IviVirtualRange object from the Virtual Range collection.
The parameter is the name or one-based index of the Virtual Range to be retrieved.
The name or one-based index of the Virtual Range to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviVirtualRange type.
An IEnumerator for the VirtualRangeCollection.
The indexer for the class gets an IviVirtualName object from the Virtual Range collection.
The parameter is the name or one-based index of the Virtual Range to be retrieved.
The name or one-based index of the Virtual Range to be retrieved.
IIviVirtualRange Interface
Same as IIviVirtualRange Interface
The lower bound of a range of integers to be appended to the Name property of the
referencing IVI Virtual Name object to create a set of virtual repeated
capability identifiers.
The upper bound of a range of integers to be appended to the Name
property of the referencing IVI Virtual Name object to create a set of virtual
repeated capability identifiers.
The name for the IviVirtualName object. This
name is used to uniquely identify the range in the collection, and is not used
in creating the set of virtual identifiers. An empty string is not a legal value.
When a range of integers is appended to the Name property of the
referencing IVI Virtual Name object to create a set of virtual repeated
capability identifiers, Starting Physical Index is added to each integer in the
range, and the result is appended to the Map To property to obtain the
corresponding set of physical
identifiers.
IviVirtualRangeClass object
IviVirtualRangeClass object constructor
The lower bound of a range of integers to be appended to the Name property of the
referencing IVI Virtual Name object to create a set of virtual repeated
capability identifiers.
The upper bound of a range of integers to be appended to the Name
property of the referencing IVI Virtual Name object to create a set of virtual
repeated capability identifiers.
The name for the IviVirtualName object. This
name is used to uniquely identify the range in the collection, and is not used
in creating the set of virtual identifiers. An empty string is not a legal value.
When a range of integers is appended to the Name property of the
referencing IVI Virtual Name object to create a set of virtual repeated
capability identifiers, Starting Physical Index is added to each integer in the
range, and the result is appended to the Map To property to obtain the
corresponding set of physical
identifiers.
IIviSoftwareModule Interface
Same as IIviSoftwareModule Interface
The name for the IviSoftwareModule object. An empty string is not a legal value.
The description of the IviSoftwareModule object.The empty string is a legal value for this property.
The version-independent COM ProgID of the software module. It may be an empty string.
The full pathname of the software module. It may be an empty string.
Prefix is a string that specifies the prefix (for IVI-C
components) or the component identifier (for IVI-COM components) of the
software module. It shall exactly match the value returned by the Prefix attribute or the Component Identifier
attributes. The empty string is a legal value for this property.
A comma-separated string that specifies the instrument models
supported by the software module. It shall exactly match the value returned by the Supported Instrument Models
attribute.
References a collection of DataComponents that modifies the object of which the
collection is a part.
A collection of all the Published APIs that are implemented by the Software Module.
Before a Published API can be added to a Software Module's Published API collection, it must already exist in the global Published API
collection. To add a Published API to a Software Module's Published API collection first get the Published API from the global collection and the add
the returned reference to the Software Module's collection.
A collection of all the PhysicalName objects defined by the Software Module.
The .NET assembly qualified class name of the software module. It may be an empty string.
IviSoftwareModuleClass Interface
IviSoftwareModuleClass Interface constructor
The name for the IviSoftwareModule object. An empty string is not a legal value.
The description of the IviSoftwareModule object.The empty string is a legal value for this property.
The version-independent COM ProgID of the software module. It may be an empty string.
Setting ModulePath always sets the value of ModulePath32.
When running in a native 32-bit context, it returns ModulePath32.
When running in a native 64-bit context, it returns ModulePath64.
It may be an empty string.
Prefix is a string that specifies the prefix (for IVI-C
components) or the component identifier (for IVI-COM components) of the
software module. It shall exactly match the value returned by the Prefix attribute or the Component Identifier
attributes. The empty string is a legal value for this property.
A comma-separated string that specifies the instrument models
supported by the software module. It shall exactly match the value returned by the Supported Instrument Models
attribute.
References a collection of DataComponents that modifies the object of which the
collection is a part.
A collection of all the Published APIs that are implemented by the Software Module.
Before a Published API can be added to a Software Module's
Published API collection, it must already exist in the global Published API
collection. To add a Published API to a Software Module's Published API
collection first get the Published API from the global collection and the add
the returned reference to the Software Module's collection.
A collection of all the PhysicalName objects defined by the Software Module.
The .NET assembly qualified class name of the software module. It may be an empty string.
The full pathname of the native 32-bit software module. It may be an empty string.
The full pathname of the native 64-bit software module. It may be an empty string.
IIviPublishedAPICollection Interface
Same as IIviPublishedAPICollection Interface
Adds an IviPublishedAPI object to the global Published API collection.
The IviPublishedAPI object to be added.
Removes an IviPublishedAPI object from the global Published API collection.
If the parameter, varIndex, is an integer, the remaining parameters are ignored
as a numeric index completely identifies the item to be removed.
The name or one-based index of the Published API to be removed.
The Major Version of the Published API to be removed.
The Minor Version of the Published API to be removed.
The Type of the Published API to be removed.
The number of IviPublishedAPI objects in the global Published API collection.
A read-only property that gets an IviPublishedAPI object from the global Published API collection.
If the parameter, varIndex, is an integer, the remaining parameters are ignored
as a numeric index completely identifies the item to be retrieved or removed.
The name or one-based index of the Published API to be retrieve.
The Major Version of the Published API to be retrieveed.
The Minor Version of the Published API to be retrieveed.
The Type of the Published API to be retrieved.
The indexer for the class gets an IviPublishedAPI object from the global Published API collection.
The parameters to the indexer are the same those for Remove. If the parameter, varIndex, is an integer,
the remaining parameters are ignored as a numeric index completely identifies the item to be retrieved.
The name or one-based index of the Published API to be retrieve.
The Major Version of the Published API to be retrieveed.
The Minor Version of the Published API to be retrieveed.
The Type of the Published API to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviPublishedAPI type.
An IEnumerator for the PublishedAPICollection.
IviPublishedAPICollectionClass object
IviPublishedAPICollectionClass object constructor
Adds an IviPublishedAPI object to the global Published API collection.
The IviPublishedAPI object to be added.
Removes an IviPublishedAPI object from the global Published API collection.
If the parameter, varIndex, is an integer, the remaining parameters are ignored
as a numeric index completely identifies the item to be removed.
The name or one-based index of the Published API to be removed.
The Major Version of the Published API to be removed.
The Minor Version of the Published API to be removed.
The Type of the Published API to be removed.
The number of IviPublishedAPI objects in the global Published API collection.
A read-only property that gets an IviPublishedAPI object from the global Published API collection.
If the parameter, varIndex, is an integer, the remaining parameters are ignored
as a numeric index completely identifies the item to be retrieved or removed.
The name or one-based index of the Published API to be retrieve.
The Major Version of the Published API to be retrieveed.
The Minor Version of the Published API to be retrieveed.
The Type of the Published API to be retrieved.
The indexer for the class gets an IviPublishedAPI object from the global Published API collection.
The parameters to the indexer are the same those for Remove. If the parameter, varIndex, is an integer,
the remaining parameters are ignored as a numeric index completely identifies the item to be retrieved.
The name or one-based index of the Published API to be retrieve.
The Major Version of the Published API to be retrieveed.
The Minor Version of the Published API to be retrieveed.
The Type of the Published API to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviPublishedAPI type.
An IEnumerator for the PublishedAPICollection.
IIviPublishedAPI Interface
Same as IIviPublishedAPI Interface
The name for the IviPublished object. An empty string is not a legal value.
The major version of this revision of the published API. This is determined by the person or group who
publishes the API.
The minor version of this revision of the published API. This is determined by the person or group who
publishes the API.
The type of a Published API. Two predefined values are supported for the IVI defined
interfaces, IVI-C and IVI-COM. These values shall be used for all IVI defined inherent and class APIs.
Other user-defined values may be used for other types of APIs. The empty string is not a legal value for this property.
IviPublishedAPIClass object
IviPublishedAPIClass object constructor
The name for the IviPublished object. An empty string is not a legal value.
The major version of this revision of the published API. This is determined by the person or group who
publishes the API.
The minor version of this revision of the published API. This is determined by the person or group who
publishes the API.
The type of a Published API. Two predefined values are supported for the IVI defined
interfaces, IVI-C and IVI-COM. These values shall be used for all IVI defined inherent and class APIs.
Other user-defined values may be used for other types of APIs. The empty string is not a legal value for this property.
IIviPhysicalNameCollection Interface
Same as IIviPhysicalNameCollection Interface
Adds an IviPhysicalName object to the Physical Name collection.
The IviPhysicalName object to be added.
Removes an IviPhysicalName object from the Physical Name collection.
The name or one-based index of the Physical Name to be removed.
The number of IviPhysicalName objects in the Physical Name collection.
A read-only property that gets an IviPhysicalName object from the Physical Name collection.
The name or one-based index of the Physical Name to be retrieved.
The indexer for the class gets an IviPhysicalName object from the Physical Name collection.
The parameter is the name or one-based index of the Physical Name to be retrieved.
The name or one-based index of the Physical Name to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviPhysicalName type.
An IEnumerator for the PhysicalNameCollection.
IviPhysicalNameCollectionClass object
IviPhysicalNameCollectionClass object constructor
Adds an IviPhysicalName object to the Physical Name collection.
The IviPhysicalName object to be added.
Removes an IviPhysicalName object from the Physical Name collection.
The name or one-based index of the Physical Name to be removed.
The number of IviPhysicalName objects in the Physical Name collection.
A read-only property that gets an IviPhysicalName object from the Physical Name collection.
The name or one-based index of the Physical Name to be retrieved.
The indexer for the class gets an IviPhysicalName object from the Physical Name collection.
The parameter is the name or one-based index of the Physical Name to be retrieved.
The name or one-based index of the Physical Name to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviPhysicalName type.
An IEnumerator for the PhysicalNameCollection.
IIviPhysicalName Interface
Same as IIviPhysicalName Interface
The name of a specific instance of a repeated capability as
defined in the software module. It shall consist of one or more of the following characters:
a-z, A-Z, 0-9, !, and _.
The empty string is valid only if the IVI Physical Name object references a non-empty collection of Physical Range objects.
A collection of the IVI Physical Name objects that are
hierarchically structured under this IVI Physical Name object. This collection will commonly be empty.
The repeated capability name as defined in the software module.
Each IVI Physical Name object represents an instance of the repeated capability of type RC Name.
For software modules that reference Published APIs that define repeated capabilities,
the RC Name shall be the repeated capability name defined by the Published API specification.
The empty string is not a legal value for this property.
A collection of Physical Range objects used to qualify the referencing IVI Physical Name object.
IviPhysicalNameClass object
IviPhysicalNameClass object constructor
The name of a specific instance of a repeated capability as
defined in the software module. It shall consist of one or more of the following characters:
a-z, A-Z, 0-9, !, and _.
The empty string is valid only if the IVI Physical Name object references a non-empty collection of Physical Range objects.
A collection of the IVI Physical Name objects that are
hierarchically structured under this IVI Physical Name object. This collection will commonly be empty.
The repeated capability name as defined in the software module.
Each IVI Physical Name object represents an instance of the repeated capability of type RC Name.
For software modules that reference Published APIs that define repeated capabilities,
the RC Name shall be the repeated capability name defined by the Published API specification.
The empty string is not a legal value for this property.
A collection of Physical Range objects used to qualify the referencing IVI Physical Name object.
IIviPhysicalRangeCollection Interface
Same as IIviPhysicalRangeCollection Interface
Adds an IviPhysicalRange object to the Phyical Range collection.
The IviPhysicalRange object to be added.
Removes an IviPhysicalRange object from the Physical Range collection.
The name or one-based index of the Physical Range to be removed.
The number of IviPhysicalRange objects in the Physical Range collection.
A read-only property that gets an IviPhysicalRange object from the Physical Range collection.
The name or one-based index of the Physical Range to be retrieved.
The indexer for the class gets an IviPhysicalRange object from the Physical Range collection.
The parameter is the name or one-based index of the Physical Range to be retrieved.
The name or one-based index of the Physical Range to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviPhysicalRange type.
An IEnumerator for the PhysicalRangeCollection.
IviPhysicalRangeCollectionClass object
IviPhysicalRangeCollectionClass object constructor
Adds an IviPhysicalRange object to the Phyical Range collection.
The IviPhysicalRange object to be added.
Removes an IviPhysicalRange object from the Physical Range collection.
The name or one-based index of the Physical Range to be removed.
The number of IviPhysicalRange objects in the Physical Range collection.
A read-only property that gets an IviPhysicalRange object from the Physical Range collection.
The name or one-based index of the Physical Range to be retrieved.
The indexer for the class gets an IviPhysicalRange object from the Physical Range collection.
The parameter is the name or one-based index of the Physical Range to be retrieved.
The name or one-based index of the Physical Range to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviPhysicalRange type.
An IEnumerator for the PhysicalRangeCollection.
IIviPhysicalRange Interface
Same as IIviPhysicalRange Interface
The upper end of a range of integers to be appended to the Name property of the
referencing IVI Physical Name object to create a set of physical repeated
capability identifiers.
The lower end of a range of integers to be appended to the Name property of the
referencing IVI Physical Name object to create a set of physical repeated
capability identifiers.
The name of the physical range. This name is used to uniquely identify the range in the collection, and
is not used in creating the set of physical identifiers. The empty string is not a legal value for this property.
IviPhysicalRangeClass object
IviPhysicalRangeClass object constructor
The upper end of a range of integers to be appended to the Name property of the
referencing IVI Physical Name object to create a set of physical repeated
capability identifiers.
The lower end of a range of integers to be appended to the Name property of the
referencing IVI Physical Name object to create a set of physical repeated
capability identifiers.
The name of the physical range. This name is used to uniquely identify the range in the collection, and
is not used in creating the set of physical identifiers. The empty string is not a legal value for this property.
IIviSessionCollection Interface
Same as IIviSessionCollection Interface
Adds an IviSession object to the global Session collection.
The IviSession object to be added.
Removes an IviSession object from the global Session collection.
The name or one-based index of the Session to be removed.
The number of IviSession objects in the global Session collection.
A read-only property that gets an IviSession object from the global Session collection.
The name or one-based index of the Session to be retrieved.
The indexer for the class gets an IviSession object from the global Session collection.
The parameter is the name or one-based index of the Session to be retrieved.
The name or one-based index of the Session to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviSession type.
An IEnumerator for the SessionCollection.
IviSessionCollectionClass object
IviSessionCollectionClass object constructor
Adds an IviSession object to the global Session collection.
The IviSession object to be added.
Removes an IviSession object from the global Session collection.
The name or one-based index of the Session to be removed.
The number of IviSession objects in the global Session collection.
A read-only property that gets an IviSession object from the global Session collection.
The name or one-based index of the Session to be retrieved.
The indexer for the class gets an IviSession object from the global Session collection.
The parameter is the name or one-based index of the Session to be retrieved.
The name or one-based index of the Session to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviSession type.
An IEnumerator for the SessionCollection.
IIviHardwareAssetCollection Interface
Same as IIviHardwareAssetCollection Interface
Adds an IviHardwareAsset object to the global Hardware Asset collection.
The IviHardwareAsset object to be added.
Removes an IviHardwareAsset object from the global Hardware Asset collection.
The name or one-based index of the Hardware Asset to be removed.
The number of IviHardwareAsset objects in the global Hardware Asset collection.
A read-only property that gets an IviHardwareAsset object from the global Hardware Asset collection.
The indexer for the class gets an IviHardwareAsset object from the global Hardware Asset collection.
The parameter is the name or one-based index of the Hardware Asset to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviHardwareAsset type.
An IEnumerator for the HardwareAssetCollection.
IviHardwareAssetCollectionClass obect
IviHardwareAssetCollectionClass obect constructor
Adds an IviHardwareAsset object to the global Hardware Asset collection.
The IviHardwareAsset object to be added.
Removes an IviHardwareAsset object from the global Hardware Asset collection.
The name or one-based index of the Hardware Asset to be removed.
The number of IviHardwareAsset objects in the global Hardware Asset collection.
A read-only property that gets an IviHardwareAsset object from the global Hardware Asset collection.
The indexer for the class gets an IviHardwareAsset object from the global Hardware Asset collection.
The parameter is the name or one-based index of the Hardware Asset to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviHardwareAsset type.
An IEnumerator for the HardwareAssetCollection.
IIviSoftwareModuleCollection Interface
Same as IIviSoftwareModuleCollection Interface
Adds an IviSoftwareModule object to the global Software Module collection.
The IviSoftwareModule object to be added.
Removes an IviSoftwareModule object from the global Software Module collection.
The name or one-based index of the Sofware Module to be removed.
The number of IviSoftwareModule objects in the global Software Module collection.
A read-only property that gets an IviSoftwareModule object from the global Software Module collection.
The indexer for the class gets an IviSoftwareModule object from the global Software Module collection.
The parameter is the name or one-based index of the Software Module to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviSoftwareModule type.
An IEnumerator for the SoftwareModuleCollection.
IviSoftwareModuleCollectionClass object
IviSoftwareModuleCollectionClass object constructor
Adds an IviSoftwareModule object to the global Software Module collection.
The IviSoftwareModule object to be added.
Removes an IviSoftwareModule object from the global Software Module collection.
The name or one-based index of the Sofware Module to be removed.
The number of IviSoftwareModule objects in the global Software Module collection.
A read-only property that gets an IviSoftwareModule object from the global Software Module collection.
The indexer for the class gets an IviSoftwareModule object from the global Software Module collection.
The parameter is the name or one-based index of the Software Module to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviSoftwareModule type.
An IEnumerator for the SoftwareModuleCollection.
IIviDriverSessionCollection Interface
Same as IIviDriverSessionCollection Interface
Adds an IviDriverSession object to the global Driver Session collection.
The IviDriverSession object to be added.
Removes an IviDriverSession object from the global Driver Session collection.
The name or one-based index of the Driver Session to be removed.
The number of IviDriverSession objects in the global Driver Session collection.
A read-only property that gets an IviDriverSession object from the global Driver Session collection.
The name or one-based index of the Driver Session to be retrieved.
The indexer for the class gets an IviDriverSession object from the global Driver Session collection.
The parameter is the name or one-based index of the Driver Session to be retrieved.
The name or one-based index of the Logical Name to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviDriverSession type.
An IEnumerator for the DriverSessionCollection.
IviDriverSessionCollectionClass object
IviDriverSessionCollectionClass object constructor
Adds an IviDriverSession object to the global Driver Session collection.
The IviDriverSession object to be added.
Removes an IviDriverSession object from the global Driver Session collection.
The name or one-based index of the Driver Session to be removed.
The number of IviDriverSession objects in the global Driver Session collection.
A read-only property that gets an IviDriverSession object from the global Driver Session collection.
The name or one-based index of the Driver Session to be retrieved.
The indexer for the class gets an IviDriverSession object from the global Driver Session collection.
The parameter is the name or one-based index of the Driver Session to be retrieved.
The name or one-based index of the Logical Name to be retrieved.
The _NewEnum property returns an IUnknown pointer. This interface
can be queried for an IEnumVARIANT interface which contains the methods: Next, Skip, Reset, and Clone.
The VARIANT returned by Next can be queried for an interface
appropriate for the collection. For example the VARIANT returned within the
Hardware Asset Collection can be queried for the IviHardwareAsset interface.
The IEnumerator interface implements the Current property and the Reset and MoveNext methods.
The Object returned by the Current property can be cast to the IviDriverSession type.
An IEnumerator for the DriverSessionCollection.
IIviDriverSession Interface
Same as IIviDriverSession Interface
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
References a collection of DataComponents that modifies the object of which the
collection is a part.
References the Hardware Asset used by the Session.
References a collection of all the IVI Virtual Name objects used by the Session.
Within a collection, the Name property uniquely identifies an IVI Virtual name object.
IVI Virtual Name objects cannot be reused between sessions.
References the Software Module configured by the Session.
The name of the current or most recently referenced software module referenced by the
Software Module property.
Driver Setup stores the string that initializes the Driver Setup
attribute in an IVI instrument specific driver. The empty string is a legal value for this property.
Cache stores the Boolean value that initializes the Cache attribute in an IVI
instrument specific driver.
Interchange Check stores the Boolean value that initializes the Interchange Check attribute
in an IVI instrument specific driver.
Query Instrument Status stores the Boolean value that initializes the Query
Instrument Status attribute in an IVI instrument specific driver.
Range Check stores the Boolean value
that initializes the Range Check attribute in
an IVI instrument specific driver.
Record Value Coercions stores the
Boolean value that initializes the Record
Value Coercions attribute in an IVI instrument specific driver.
Simulate stores the Boolean value
that initializes the Simulate attribute in an
IVI instrument specific driver.
IviDriverSessionClass object
IviDriverSessionClass object constructor
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
References a collection of DataComponents that modifies the object of which the
collection is a part.
References the Hardware Asset used by the Session.
References a collection of all the IVI Virtual Name objects used by the Session.
Within a collection, the Name property uniquely identifies an IVI Virtual name object.
IVI Virtual Name objects cannot be reused between sessions.
References the Software Module configured by the Session.
The name of the current or most recently referenced software module referenced by the
Software Module property.
Driver Setup stores the string that initializes the Driver Setup
attribute in an IVI instrument specific driver. The empty string is a legal value for this property.
Cache stores the Boolean value that initializes the Cache attribute in an IVI
instrument specific driver.
Interchange Check stores the Boolean value that initializes the Interchange Check attribute
in an IVI instrument specific driver.
Query Instrument Status stores the Boolean value that initializes the Query
Instrument Status attribute in an IVI instrument specific driver.
Range Check stores the Boolean value
that initializes the Range Check attribute in
an IVI instrument specific driver.
Record Value Coercions stores the
Boolean value that initializes the Record
Value Coercions attribute in an IVI instrument specific driver.
Simulate stores the Boolean value
that initializes the Simulate attribute in an
IVI instrument specific driver.
IIviConfigStore Interface
Same as IIviConfigStore Interface
Reads a configuration store file from
a data source location, parses the data, and
creates the corresponding Configuration Server
classes in memory.
The full pathname of the configuration store file to be opened.
Serializes a configuration store from
the Configuration Server to a data source
location. The Serialize method creates the
configuration file specified by the Location
parameter.
The full pathname of the configuration store file to be written.
Returns a driver session, given a name that identifies the session.
Name may be either the Name
of the Driver Session object, or a logical
name that refers to the Driver Session object.
Reference to an IviDriverSession object.
Returns a session, given a name that identifies the session.
Name may be either the Name
of the Session object, or a logical name that
refers to the Session object.
Reference to an IviSession object.
The name of the Configuration Server which is always IVI Configuration Server.
The description of the Configuration
Server component. In a newly created object,
this string is "The IVI Configuration Server
allows access to and modification of an IVI
configuration store."
The vendor of the Configuration Server component which is always "IVI Foundation, Inc.".
The current revision of the Configuration Server.
The major version of the
Configuration Server specification supported
by the Configuration Server component.
The minor version of the Configuration Server specification supported by the Configuration Server component.
The global collection of all Hardware Asset objects in the configuration store.
The global collection of all Driver Session objects in the configuration store.
The global collection of all Logical Name objects in the configuration store.
The global collection of all IVI Session objects in the configuration store.
The global collection of all Published API objects in the configuration store.
The global collection of all Software Modules objects in the configuration store.
The full pathname of the master
configuration store including the file name,
which is always
IviConfigurationStore.xml.
The full pathname of the default
configuration store for the process in which
this property is used. If a non-empty string
is assigned to this property by code executed
in the process, the property shall return that
string when accessed in the same process. The
empty string is a legal value for this
property.
The full pathname of the
configuration store file that was successfully
deserialized by the current instance of the
configuration server. If no configuration
store file has been successfully deserialized
by the current instance of the configuration
server, the property returns the empty
string.
IviConfigStoreClass object
IviConfigStoreClass object constructor
Reads a configuration store file from
a data source location, parses the data, and
creates the corresponding Configuration Server
classes in memory.
The full pathname of the configuration store file to be opened.
Serializes a configuration store from
the Configuration Server to a data source
location. The Serialize method creates the
configuration file specified by the Location
parameter.
The full pathname of the configuration store file to be written.
Returns a driver session, given a name that identifies the session.
Name may be either the Name
of the Driver Session object, or a logical
name that refers to the Driver Session object.
Reference to an IviDriverSession object.
Returns a session, given a name that identifies the session.
Name may be either the Name
of the Session object, or a logical name that
refers to the Session object.
Reference to an IviSession object.
The name of the Configuration Server which is always IVI Configuration Server.
The description of the Configuration
Server component. In a newly created object,
this string is "The IVI Configuration Server
allows access to and modification of an IVI
configuration store."
The vendor of the Configuration Server component which is always "IVI Foundation, Inc.".
The current revision of the Configuration Server.
The major version of the
Configuration Server specification supported
by the Configuration Server component.
The minor version of the Configuration Server specification supported by the Configuration Server component.
The global collection of all Hardware Asset objects in the configuration store.
The global collection of all Driver Session objects in the configuration store.
The global collection of all Logical Name objects in the configuration store.
The global collection of all IVI Session objects in the configuration store.
The global collection of all Published API objects in the configuration store.
The global collection of all Software Modules objects in the configuration store.
The full pathname of the master
configuration store including the file name,
which is always
IviConfigurationStore.xml.
The full pathname of the default
configuration store for the process in which
this property is used. If a non-empty string
is assigned to this property by code executed
in the process, the property shall return that
string when accessed in the same process. The
empty string is a legal value for this
property.
The full pathname of the
configuration store file that was successfully
deserialized by the current instance of the
configuration server. If no configuration
store file has been successfully deserialized
by the current instance of the configuration
server, the property returns the empty
string.
IIviStructure Interface
Same as IIviStructure Interface
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
A collection of IVI Data Component
objects. Circular references or a circular
series of references are not
allowed.
IviStructureClass object
IviStructureClass object constructor
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
A collection of IVI Data Component
objects. Circular references or a circular
series of references are not
allowed.
IIviAPIReference Interface
Same as IIviAPIReference Interface
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
A session name that implements the published API.
A published API to be associated with the client role identified by the Name property.
IviAPIReferenceClass Object
IviAPIReferenceClass Object constructor.
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
A session name that implements the published API.
A published API to be associated with the client role identified by the Name property.
IIviReal Interface
Same as IIviReal Interface
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
The units to be applied to Value. The empty string is a legal value for this property.
The real value of the data component.
IviRealClass object
IviRealClass object constructor
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
The units to be applied to Value. The empty string is a legal value for this property.
The real value of the data component.
IIviInteger Interface
Same as IIviInteger Interface
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
The units to be applied to Value. The empty string is a legal value for this property.
The integer value of the data component.
IviIntegerClass object
IviIntegerClass object constructor
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
The units to be applied to Value. The empty string is a legal value for this property.
The integer value of the data component.
IIviString Interface
Same as IIviString Interface
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
The string value of the data component.
IviStringClass object
IviStringClass object constructor
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
The string value of the data component.
IIviBoolean Interface
Same as IIviBoolean Interface
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
The Boolean Value of the data component.
IviBooleanClass object
IviBooleanClass object constructor
The name of the associated object. The empty string is not a legal value for this property.
The description of the associated object. The empty string is a legal value for this property.
This property determines whether a data component associated with a software module
is used in a session that references the software module. The possible
values are Required, Optional, and None.The values are case insensitive.
A string denoting the data type of the associated data element. Valid values for this field are Structure,
Integer, Real, Boolean, String, and APIReference.
Indicates whether the value of the data component may be changed in a configuration store GUI.
The help context ID for the data component.
The fully qualified pathname of the help file that provides the help for the data component.
A string that the software module uses to identify the internal
software element that the data component applies to. If Used In Session is None, the value of
this property shall be the empty string.
If Used In Session is Required or Optional, the value of this
property shall not be the empty string.
The Boolean Value of the data component.
Ivi Configuration Server Error Enum
The specified configuration store file could not be deserialized.
A deserialize was attempted after a previous deserialize had already succeeded.
The specified configuration store file could not be serialized.
The session name or logical name could not be resolved to a session or driver session.
The item does not exist in the global collection.
An entry with name already exists in the collection.
The registry entry for the master
configuration store does not exist or the file
could not be found.
The item does not exist in the collection.
The data component is not a valid data component.
The element cannot be removed from the global collection when it is referenced in the local collections.