CSIBCSearchPath Class Reference

#include <SIBCSearchPath.h>

List of all members.

Public Member Functions
	CSIBCSearchPath ()
SI_Error	AddPath (CSIBCString &in_Path)
SI_Error	ClearPaths ()
SI_Error	Search (CSIBCString &file, CSIBCString &resultpath)
SI_Error	GetFiles (CSIBCString &in_Filter, CSIBCArray< CSIBCString * > *out_pFiles)
SI_Error	GetDirectories (CSIBCString &in_Filter, CSIBCArray< CSIBCString * > *out_pDirs)
CSIBCArray< CSIBCString * > &	GetPaths ()

Detailed Description

This class provides an easy method for locating files within designated search paths

Constructor & Destructor Documentation

Member Function Documentation

Clears all search paths associated with this object.

Return values:

SI_Error::SI_SUCCESS

The search path was added successfully.

See also:

CSIBCSearchPath::AddPath

CSIBCSearchPath::GetPaths

Searches for a file named file, in the search paths added with CSIBCSearchPath::AddPath.

Parameters:

[in]	file	Filename to search for.
[out]	resultpath	Contains the full path and filename of the file, if found.

Return values:

	SI_Error::SI_SUCCESS	The file was located. resultpath contains the path and filename.
	SI_Error::SI_FILE_NOT_FOUND	The file could not be found (resultpath is unchanged).

See also:

CSIBCSearchPath::GetFiles

CSIBCSearchPath::AddPath

CSIBCSearchPath::GetPaths

Returns an array of all files matching in_Filter in the search paths for this object. This function will also return any directories matching the search filter.

Parameters:

[in]	in_Filter	The filename to search for (can include wildcards).
[out]	out_pFiles	Pointer to an array of strings to append the full paths and filenames of files matched to in_Filter in this object's search paths. The strings added to this array must be freed by the caller.

Return values:

SI_Error::SI_SUCCESS

The command was successful.

See also:

CSIBCSearchPath::GetDirectories

CSIBCSearchPath::Search

CSIBCSearchPath::AddPath

CSIBCSearchPath::GetPaths

Exactly like GetFiles, except that only directories matching the filter are returned.

Parameters:

[in]	in_Filter	The filename to search for (can include wildcards).
[out]	out_pDirs	Pointer to an array of strings to append the full paths of directories matched to in_Filter in this object's search paths. The strings added to this array must be freed by the caller.

Return values:

SI_Error::SI_SUCCESS

The command was successful.

See also:

CSIBCSearchPath::GetFiles

CSIBCSearchPath::Search

CSIBCSearchPath::AddPath

CSIBCSearchPath::GetPaths

Returns the array containing the search paths defined for this object.

Returns:

Reference to the array containing the search paths for this object.

See also:

CSIBCSearchPath::AddPath

CSIBCSearchPath::ClearPaths

• SIBCSearchPath.h