VCNextEntityExpand


Version:

1.2

Description:

Positions a pointer for entity operations to the next entity in the database after the current one.

Declaration:

 

C/C++

extern "C" vbool WINAPI VCNextEntityExpand(short* iError, short* bKind);

Delphi

function VCNextEntityExpand(var iError: Smallint; var bKind: Smallint):Wordbool;

ActiveX/COM

Function NextEntityExpand() As Integer

Parameters:

bKind - set by the function to what type of entity is now current.

Return Value:

0 if not successful and 1 otherwise.
ActiveX/COM returns the entity kind (UNKNOWN if not successful)

iError Code:

0 - Success
1 - Invalid world

Notes:

Whenever querying entities for their particular properties, it is necessary to have a method to step through the drawing database and select which entity a given query will focus on. The API offer several utility parsing methods for flexibility in locating entities in the database. Each offers advantages in certain situations. VCFirst/NextEntity move through each entity in the drawing database. VCFirst/NextEntityExpand parses the database as if the drawing file had been exploded. Every entity, including those in symbol definition and hatch patterns are included in the search. VCFirst/NextOnScreen clip the drawing and allow for quick entity access to only those entities found in the current zoom. VCFirst/NextSelected parse only through the selection set. This method combined with a selection filter allow access to specific entities meeting a set of criteria quickly in the drawing database. If no entities exist for the method, the return value will be a 0 and the code can handle this case accordingly.

The VCFirst/Next functions operate relative to the current entity.  If code which uses VCFirst/Next in a loop changes the current entity, it is important that the current entity be reset to the entity returned by the previous VCFirst/Next call.

See Also:

VCFirstEntity, VCLastEntity, VCFirstEntityExpand, VCFirstEntity, VCNextOnScreen, VCFirstSelected, VCNextSelected, VCSetCurrentEntity