BrowseContainer Class Reference

#include <c4d_gedata.h>

Detailed Description

A convenience class for browsing through the items in a BaseContainer.

Warning

It is not allowed to add or remove elements while browsing the container.

Public Member Functions
	BrowseContainer (const BaseContainer *bc)
void	Reset ()
Bool	GetNext (Int32 *id, GeData **data)

Private Attributes
BaseContainer *	t_bc
void *	handle

Constructor & Destructor Documentation

BrowseContainer()

BrowseContainer

(

const BaseContainer *

bc

)

Constructs the browser with the passed container.

Parameters

[in]

bc

The container to browse. The caller owns the pointed container.

Member Function Documentation

Reset()

void Reset

(

)

Resets the browser to the construction state.

GetNext()

Bool GetNext	(	Int32 *	id,
		GeData **	data
	)

Retrieves the next item in the container.

Warning

It is not allowed to modify the retrieved data.

Parameters

[out]	id	Assigned the ID of the item.
[out]	data	Assigned the item's data. The container owns the pointed data.

Returns

true if the next item was retrieved, otherwise false.

Member Data Documentation

t_bc

BaseContainer* t_bc

private

handle

void* handle

private