update

Update entry of IVI configuration store object

Syntax

update(obj, 'type', 'name', 'P1', V1, ...) update(obj, struct)

Arguments

`obj`	IVI^® configuration store object.
`'``type``'`	Type of entry; `type` can be `HardwareAsset`, `DriverSession`, or `LogicalName`.
`'name'`	Name of the `DriverSession`, `HardwareAsset`, or `LogicalName` to be updated.
`'``P1``'`	First parameter for updated entry; other parameter-value pairs may follow.
`V1`	Value for first parameter.
`struct`	Structure defining entry fields to be updated.

Description

update(obj, 'type', 'name', 'P1', V1, ...) updates an entry of type, type, with name, name, in IVI configuration store object, obj, using the specified parameter-value pairs. type can be HardwareAsset, DriverSession, or LogicalName.

If an entry of type, type with name, name does not exist, an error will occur.

Valid parameters for a DriverSession are listed below. The default value for on/off parameters is off.

Parameter	Value	Description
`Name`	character vector	A unique name for the driver session.
`SoftwareModule`	character vector	The name of a software module entry in the configuration store.
`HardwareAsset`	character vector	The name of a hardware asset entry in the configuration store.
`Description`	Any character vector	Description of driver session
VirtualNames	structure	A struct array containing virtual name mappings
`Cache`	`on`/`off`	Enable caching if the driver supports it.
`DriverSetup`	Any character vector	This value is software module dependent
`InterchangeCheck`	`on`/`off`	Enable driver interchangeability checking, if supported
`QueryInstrStatus`	`on`/`off`	Enable instrument status querying by the driver
`RangeCheck`	`on`/`off`	Enable extended range checking by the driver, if supported
`RecordCoercions`	`on`/`off`	Enable recording of coercions by the driver, if supported
`Simulate`	`on`/`off`	Enable simulation by the driver

Valid fields for HardwareAsset are

Parameter	Value	Description
`Name`	character vector	A unique name for the hardware asset
`Description`	Any character vector	Description of hardware asset
`IOResourceDescriptor`	character vector	The I/O address of the hardware asset

Valid fields for LogicalName are

Parameter	Value	Description
Name	character vector	A unique name for the logical name
`Description`	Any character vector	Description of hardware asset
Session	character vector	The name of a driver session entry in the configuration store

update(obj, struct) updates the entry using the fields in struct. If an entry with the type and name field in struct does not exist, an error will occur. Note that the name field cannot be updated using this syntax.

Note

To get a list of options you can use on a function, press the Tab key after entering a function on the MATLAB^® command line. The list expands, and you can scroll to choose a property or value. For information about using this advanced tab completion feature, see Using Tab Completion for Functions.

Examples

Update the Description parameter of the driver session named ScopeSession in the IVI configuration store object named c.

c = iviconfigurationstore;
update(c, 'DriverSession', 'ScopeSession', 'Description', ... 
'A session.');

Version History

Introduced before R2006a