BrowseFiles Class Reference

#include <c4d_file.h>

Detailed Description

Helper to browse through files.

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 (const Filename &directory, Int32 flags)
Bool	GetNext ()
Int64	GetSize ()
Bool	IsDir ()
Bool	IsHidden ()
Bool	IsBundle ()
Bool	IsReadOnly ()
void	GetFileTime (Int32 mode, LocalFileTime *out)
Filename	GetFilename ()

Private Member Functions
	BrowseFiles ()
	~BrowseFiles ()

Alloc/Free
using	IsAllocType = std::true_type
static BrowseFiles *	Alloc ()
static BrowseFiles *	Alloc (const maxon::SourceLocation &)
static void	Free (BrowseFiles *&bf)

Member Typedef Documentation

IsAllocType

using IsAllocType = std::true_type

Constructor & Destructor Documentation

BrowseFiles()

BrowseFiles ( )

private

~BrowseFiles()

~BrowseFiles ( )

private

Member Function Documentation

Alloc() [1/2]

static BrowseFiles* Alloc ( )

static

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

Returns

The allocated file browser, or nullptr if the allocation failed.

Alloc() [2/2]

static BrowseFiles* Alloc ( const maxon::SourceLocation &  )

static

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

Returns

The allocated file browser, or nullptr if the allocation failed.

Free()

static void Free ( BrowseFiles *&  bf )

static

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

Parameters

[in,out]

bf

The file browser to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

Init()

void Init	(	const Filename &	directory,
		Int32	flags
	)

Initializes the class to browse a certain directory.

Parameters

[in]	directory	The directory to browse.
[in]	flags	The browser files flags: BROWSEFILES

GetNext()

Bool GetNext

(

)

Gets the next file or subdirectory in the browsed directory.

Note

To retrieve the first file call GetNext() once. Example:

AutoAlloc<BrowseFiles> bf;
if (bf == nullptr)
  return;
 
bf->Init(dir, BROWSEFILES_CALCSIZE);
while (bf->GetNext())
{
  GePrint(bf->GetFilename().GetString());
}

Returns

true if another file was found, otherwise false.

GetSize()

Int64 GetSize

(

)

Gets the size for the current file.

Returns

The byte size of the file.

Warning

Not valid for directories.

IsDir()

Bool IsDir

(

)

Checks if the current element is a directory.

Returns

true if the current element is a directory, otherwise false.

IsHidden()

Bool IsHidden

(

)

Checks if the current file or directory is hidden.

Returns

true if the current file is hidden, otherwise false.

IsBundle()

Bool IsBundle

(

)

Checks if the current file or directory is a bundle.

Returns

true if the current file is a bundle, otherwise false.

IsReadOnly()

Bool IsReadOnly

(

)

Checks if the current file or directory is read-only.

Returns

true if the current file is read-only, otherwise false.

GetFileTime()

void GetFileTime	(	Int32	mode,
		LocalFileTime *	out
	)

Gets a time for the current file or directory.

Parameters

[in]	mode	The file time mode: GE_FILETIME
[out]	out	Filled with the retrieved file time. The caller owns the pointed file time.

GetFilename()

Filename GetFilename

(

)

Gets the name of the current file or directory.

Returns

The name of the current file or directory.