sb_cs::SbFolder Class Reference

Folder Class that wraps the sb_t_folder structure More...

#include <cs_folder.h>

Inheritance diagram for sb_cs::SbFolder:

Collaboration diagram for sb_cs::SbFolder:

Static Public Member Functions
static SbFolder	Load (String^ path, String ^ext, bool sort, int verbosity)
	Creates the list of the name of the files in a specified folder. More...
Static Public Member Functions inherited from sb_cs::SbCommon
static String	FormatError (SbError error)
	Returns the error message. More...

Data Fields
array< String^>	files
	Array of files. More...

Additional Inherited Members
Public Member Functions inherited from sb_cs::SbCommon
SbError	Error ()
	Returns the error code of the last operation. If no error SbError.SB_ERR_NONE is returned. More...
String	ErrorMsg ()
	Returns the error message of the last operation. More...

Detailed Description

Folder Class that wraps the sb_t_folder structure

Definition at line 15 of file cs_folder.h.

Member Function Documentation

Load()

static SbFolder sb_cs::SbFolder::Load ( String^  path, String ^  ext, bool  sort, int  verbosity  )

static

Creates the list of the name of the files in a specified folder.

Parameters

path	Name of the folder
ext	Extensions of the files. It is possible to concatenate multiple extensions separated by the SB_DELIMITER character, for example "pgm;ppm;bmp"
sort	If the value is true the list of files is sorted in a lexiconic way
verbosity	Verbosity of the message. Set to 0 to disable all the messages

Returns

An instance to the SbFolder class or null in case of memory error.
The instance returned is valid only if the SbFolder.Error() is equal to SbError::SB_ERR_NONE, otherwise an error occurred.

See also

sb_folder_load

Field Documentation

files

array<String^> sb_cs::SbFolder::files

Array of files.

See also

sb_t_file

Definition at line 22 of file cs_folder.h.

---

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

• cs_folder.h