TmGetUniqueToolName Function

Returns a unique name for a particular instance of a specified VDA Tool.

Usage

unique_name = TmGetUniqueToolName(tool_name)

Parameters

tool_name—A string containing the unique name of a VDA Tool.

Returned Value

unique_name—A unique name for the specified VDA Tool.

Keywords

None.

Discussion

Each VDA Tool must have a unique name, which allows the Tools Manager to keep track of multiple instances of a VDA Tool. This unique name must be registered with the Tools Manager before the VDA Tool can be used. To register a VDA Tool name, use the TmRegister function.

Example

This call obtains a unique name for the VDA Tool called WzPlotTool.

unique = TmGetUniqueToolName('WzPlotTool')