VCOM:VectorWorks:ISDK::FirstAuxObject

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

Returns the first object in h's aux list, or nil if h's aux list is empty. From this first object, you may reach successive objects by calling NextObject.

virtual MCObjectHandle FirstAuxObject(
MCObjectHandle h)

Parameters

MCObjectHandle h No information available.

Return Value

On error returns: nil

Remarks

A loop to iterate over all the objects in an aux list looks something like this:

for (MCObjectHandle h = gSDK->FirstAuxObject( owner ); h != NULL; h = gSDK->NextObject( h )) {

  // Do your thing here. 

}

This routine is supplied for advanced users - normally you should use VCOM:VectorWorks:ISDK::FindAuxObject and VCOM:VectorWorks:ISDK::NextAuxObject.

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]]