VCOM:VectorWorks:ISDK::NextAuxObject

From Vectorworks Developer
Jump to navigation Jump to search

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks

Member of VCOM:VectorWorks:ISDK

Similar to FindAuxObject, but begins searching at the specified object. See NextDataObject for sample code.

virtual MCObjectHandle NextAuxObject(
MCObjectHandle start,
short objectType)

Parameters

MCObjectHandle start No information available.
short objectType No information available.

Return Value

On error returns: nil

Remarks

You should call ISDK::NextObject before calling 'NextAuxObject'. The 'NextAuxObject' will return the same object that has been passed if it matches the type.

The correct use of this function is:

MCObjectHandle hNextAux = gSDK->NextObject( start );
hNextAux = gSDK->NextAuxObject( hNextAux, objectType );

Example

Looping all records attached to an object:

  MCObjectHandle hRecord = gSDK->FindAuxObject( hOwnerObject, kRecordNode );
  while ( hRecord ) {
    // ...

    hRecord = gSDK->NextObject( hRecord );
    hRecord = gSDK->NextAuxObject( hRecord, kRecordNode );
}

Version

Availability: from Vectorworks 2009

See Also

ISDK::AttachAuxObject | ISDK::DeleteAuxObject | ISDK::FindAuxObject | ISDK::FirstAuxObject | ISDK::NextAuxObject

[[VCOM:VectorWorks:ISDK::AttachAuxObject|ISDK::AttachAuxObject]] | [[VCOM:VectorWorks:ISDK::DeleteAuxObject|ISDK::DeleteAuxObject]] | [[VCOM:VectorWorks:ISDK::FindAuxObject|ISDK::FindAuxObject]] | [[VCOM:VectorWorks:ISDK::FirstAuxObject|ISDK::FirstAuxObject]] | [[VCOM:VectorWorks:ISDK::NextAuxObject|ISDK::NextAuxObject]]