VCGetSymbolName


Version:

1.2

Description:

Retrieves a symbol name from its symbol index.

Declaration:

 

C/C++

extern "C" short WINAPI VCGetSymbolName(char* pName, short i);

Delphi

function VCGetSymbolName(pName: PAnsiChar; i: Smallint):Smallint; stdcall;

ActiveX/COM

Function GetSymbolName(ByVal i As Integer) As String

Parameters:

pName - the name of the symbol.
i
- the index number of the symbol.
Returns
- the number of characters in the name string

Notes:

When parsing through a set of symbol definitions, the symbol name is not used by many of the Visual CADD™ procedures. When an application is interfacing with people however, it is typically required that the user know the name of a symbol. VCGetSymbolName will retrieve this information. Also whenever a symbol is loaded or created in a Visual CADD™ session it is indexed in order of creation or loading. This may be fine if an application loads symbols in a specific order, but it may be necessary to parse through the loaded symbols to retrieve the name and compare it with a symbol name used by the application.

See Also:

VCGetSymName, VCGetSymbolIndex