VCGetCurrentEntityLayerName


Version:

1.2

Description:

Retrieves the layer name of the current entity.

Declaration:

 

C/C++

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

Delphi

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

ActiveX/COM

Function GetCurrentEntityLayerName() As String

Parameters:

pName - set by the subroutine to be the name of the layer containing the entity.

Notes:

The current entity is set with VCSetCurrentEntity, VCFirstEntity, VCNextEntity or VCLastEntity. This allows subsequent use of the VCGetCurrentEntity* functions. If the current entity's layer is named, then VCGetCurrentEntityLayerName will return that string. If not, then VCGetCurrentEntityLayerName will return a 1 for iError and VCGetCurrentEntityLayer can be used to retrieve the layer index number.

See Also:

VCGetCurrentEntityColor, VCGetCurrentEntityHandle, VCGetCurrentEntityKind, VCGetCurrentEntityLayer,VCGetCurrentEntityLineType, VCGetCurrentEntityLineWidth, VCGetCurrentEntityLineWidthValue, VCLastEntity, VCSetCurrentEntity