PhysicalName::Name

Returns the repeated capability physical name.

Syntax

const char* Name() const;

Return value

The repeated capability physical name.

Remarks

For a nested repeated capability, this represents the identifier for this particular repeated capability instance within the parent repeated capability instance.

For example, the full name of a nested repeated capability would be of the form:

a1:b2:c3

This Name function would have the value c3 if this physical name were associated with the most nested repeated capability of the three repeated capabilities in the hierarchy implied above.

Example

The following example demonstrates use of the Name function.

ViStatus _VI_FUNC acme4321_ConfigureArmCount(ViSession Vi, ViConstString RepCapIdentifier, ViInt32 ArmCount)
{
    // The Trace repeated capability is a child repeated capability of some other repeated capability
    // that defines a "C1" physical name.  The "trace" variable below represents the "T1" Trace instance
    // within the C1 instance of the parent repeated capability.
    //
    PhysicalName<Trace> trace("C1:T1");

    cout << trace.Name();  // prints "T1"
}