ParameterStyleRepCap::RemovePhysicalNames

Removes one or more physical names from a repeated capability.

Syntax

static ViStatus RemovePhysicalNames(ViSession Vi, const std::string& strSelector);

Parameters

Vi

[in] ViSession handle for the driver session.

strSelector

[in] A repeated capability selector which can include virtual names, physical names, comma-separated lists of names and physical name ranges.

Return value

Returns a VI_SUCCESS if the operation was successful or a failure ViStatus otherwise.

Remarks

The RemovePhysicalNames function is used to remove physical names from a repeated capability. This can be useful for drivers that support dynamic repeated capabilities — that is, repeated capabilities where the exact number of repeated capabilities is not known upfront or where the driver exposes functions that allow the end user to control the physical names present, as in the standard IVI-defined IviLxiSync API.

The strSelector parameter can include lists and ranges of physical names and is parsed and expanded according to the IVI-defined rules for repeated capability selectors, as presented in “IVI 3.1 Section 4.4.7 Formal Syntax for Repeated Capability Selectors”.

Selectors have a general form such as the following:

a1,a3,a5-a7:b2:[c5,c7]

Example

The following example demonstrates how a developer might use the RemovePhysicalNames function to implement the RemoveArmSource function defined in the IviLxiSync API.

ViStatus _VI_FUNC acme_IviLxiSync_RemoveArmSource(ViSession Vi, ViConstString SourceName)
{
   auto status = VI_SUCCESS;

   status = ArmSource::RemovePhysicalNames(Vi, SourceName);

   return status;
}