DriverSession::TranslateVirtualName

Returns the repeated capability physical name associated with the specified virtual name.

virtual const std::string TranslateVirtualName(const std::string& strVirtualName) const;

const std::string TranslateVirtualName(ViSession Vi, const std::string& strVirtualName);

Parameters

Vi: [in] ViSession handle for the driver session.
strVirtualName: [in] Repeated capability virtual name for which the corresponding physical name should be returned.

Return Value

The repeated capability physical name associated with the specified virtual name. If the strVirtualName supplied is not in the map then that same strVirtualName value is returned.

Remarks

When a client application initializes an IVI driver using a logical name or a driver session name for the ResourceName parameter in the init or InitWithOptions function, the driver is required to load all of the repeated capability virtual names that the end user may have created in the IVI Configuration Store. The driver is then required to accept any of these virtual names as valid identifiers for repeated capabilities when the client application performs operations on repeated capability-based functions or attributes. The driver supports this functionality by translating virtual names, which are user-specified, to physical names, which are driver specified and which must ultimately be used in the driver implementation. The TranslateVirtualName function exposes this translation capability.

The reverse operation of translating from physical names to virtual names is provided by the TranslatePhysicalName function. In addition, the entire set of virtual-to-physical name mappings can be retrieved at once via the VirtualNameMappings Function.

For additional information on repeated capability virtual names and physical names, see the topic on Repeated Capabilities in the IVI Backgrounder section.