VCGetSymbolIndex

Version:

1.2

Description:

Returns an index of the specified symbol name for use in other symbol functions or subroutines.

Declaration:

C/C++

extern "C" short WINAPI VCGetSymbolIndex(short* iError, char* pName);

Delphi

function VCGetSymbolIndex(var iError: Smallint; pName: PAnsiChar):Smallint; stdcall;

ActiveX/COM

Function GetSymbolIndex(ByVal pName As String) As Integer

Parameters:

pName - the name of the symbol.
Returns - the symbol index number.

Notes:

Several subroutines use the symbol index in order to add entities to a symbol definition. These include VCAddLineEntity, VCAddCircleEntity, VCAddPointEntity as well as several others. In order to add these entities into a symbol definition and thus create a symbol from the external application, it is necessary to know the symbol index. VCGetSymbolIndex provides this. VCCreateSymbolDef must first be used to create a symbol definition to get a index or add entities, unless the symbol is loaded previously via Visual CADD™.