BrowseVolumes Class Reference

#include <c4d_file.h>

详细描述

Helper to browse through volumes.

注意
Has to be created with Alloc() and destroyed with Free() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

公共成员函数

void  Init (void)
Bool   GetNext (void)
Filename   GetFilename (void)
String   GetVolumeName ( Int32 *out_flags)

私有成员函数

  BrowseVolumes ()
  ~BrowseVolumes ()

Alloc/Free

static BrowseVolumes Alloc ()
static void  Free ( BrowseVolumes *&bf)

构造函数 & 析构函数文档编制

◆  BrowseVolumes()

BrowseVolumes () private

◆  ~BrowseVolumes()

~ BrowseVolumes () private

成员函数文档编制

◆  Alloc()

static BrowseVolumes * Alloc ( )
static

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

返回
The allocated volume browser, or nullptr if the allocation failed.

◆  Free()

static void Free ( BrowseVolumes *&  bf )
static

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

参数
[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.

返回
true if another volume was found, otherwise false .

◆  GetFilename()

Filename GetFilename ( void  )

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

返回
The filename of the current volume.

◆  GetVolumeName()

String GetVolumeName ( Int32 out_flags )

Gets the current volume name.

参数
[out] out_flags The flags to check: BROWSEVOLUMES
返回
The current volume name.