#include <fbxfolder.h>

Class Description

Class for iterating into file system folders and the items contained.

Definition at line 25 of file fbxfolder.h.

Public Types
enum	EEntryType { eRegularEntry, eFolderEntry }
	The different entry type that can be found in folders. More...

Public Member Functions
bool	Open (const char *pFolderPath_UTF8)
	Open the specified folder for browsing its content. More...

bool	Next ()
	Get the next item in the folder. More...

EEntryType	GetEntryType () const
	Get the type of the current entry in the folder. More...

FbxString	GetEntryName () const
	Retrieve the name of the current entry in the folder. More...

char *	GetEntryExtension () const
	Retrieve the extension name of the current entry. More...

void	Close ()
	Close the folder when done browsing its content. More...

bool	IsOpen () const
	Find out if the folder was successfully opened the last time Open was called. More...

Member Enumeration Documentation

◆ EEntryType

enum EEntryType

The different entry type that can be found in folders.

Enumerator
eRegularEntry	Regular entry, such as file.
eFolderEntry	Folder entry that potentially contain more files.

Definition at line 29 of file fbxfolder.h.

     {
         eRegularEntry,  
         eFolderEntry    
     };

Member Function Documentation

◆ Open()

bool Open ( const char * pFolderPath_UTF8 )

Open the specified folder for browsing its content.

Parameters

pFolderPath_UTF8 The folder path to open.

Returns: True if the folder path was successfully open, false otherwise.

◆ Next()

bool Next ( )

Get the next item in the folder.

Returns: True if another item was found after the current one.

◆ GetEntryType()

EEntryType GetEntryType ( ) const

Get the type of the current entry in the folder.

Returns: The entry type.

◆ GetEntryName()

FbxString GetEntryName ( ) const

Retrieve the name of the current entry in the folder.

Returns: The name of the current entry.

◆ GetEntryExtension()

char* GetEntryExtension ( ) const

Retrieve the extension name of the current entry.

Returns: The extension name of the current entry.

◆ Close()

void Close ( )

Close the folder when done browsing its content.

◆ IsOpen()

bool IsOpen ( ) const

Find out if the folder was successfully opened the last time Open was called.

Returns: True if the folder is currently open.

The documentation for this class was generated from the following file:

fbxsdk/core/base/fbxfolder.h