GetNthFromObject

Gets the nth element of a collection.

Synopsis

Err GetNthFromObject( CObject *obj, int32 n,(void**) ptr )

Description

This is a method macro that is part of the Juggler object-oriented toolbox. An object's method can be called explicitly through the class structure function pointer, or with one of the defined method macros.

This method macro returns a pointer to the nth element of a collection so that a task can find out what elements are included in the collection. Note that element numbering within a collection starts at 0.

Arguments

obj: A pointer to the CObject data structure for the object.

n: A value indicating the element to get, starting at 0.

ptr: A variable in which to store a pointer to the element found.

Return Value

This macro returns 0 if successful or an error code (a negative value) if an error occurs.

Implementation

Macro implemented in cobj.h V20.

Associated Files

cobj.h, music.lib