#include <c4d_file.h>

Detailed Description

Helper to browse through volumes.

Note: Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Public Member Functions
void	Init (void)

Bool	GetNext (void)

Filename	GetFilename (void)

String	GetVolumeName (Int32 *out_flags)

Private Member Functions
	BrowseVolumes ()

	~BrowseVolumes ()

Alloc/Free
static BrowseVolumes *	Alloc ()

static void	Free (BrowseVolumes *&bf)

Constructor & Destructor Documentation

◆ BrowseVolumes()

BrowseVolumes ( )

private

◆ ~BrowseVolumes()

~BrowseVolumes ( )

private

Member Function Documentation

◆ Alloc()

static BrowseVolumes* Alloc ( )

static

Allocates a volume browser. Destroy the allocated volume browser with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Returns: The allocated volume browser, or nullptr if the allocation failed.

◆ Free()

static void Free ( BrowseVolumes *& bf )

static

Destructs volume browsers allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters

[in,out] bf The volume browser to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆ Init()

void Init ( void )

Initializes the class to browse volumes.

◆ GetNext()

Bool GetNext ( void )

Gets the next volume.

Returns: true if another volume was found, otherwise false.

◆ GetFilename()

Filename GetFilename ( void )

Gets the filename of the current volume, retrieved with GetNext().

Returns: The filename of the current volume.

◆ GetVolumeName()

String GetVolumeName ( Int32 * out_flags )

Gets the current volume name.