![]() |
![]() |
![]() |
![]() |
||||
![]() |
![]() |
![]() |
![]() |
||||
|
recls
namespace.
Modules | |
recls.c++ | |
The recls C++ mapping. It resides within the recls::cpp namespace. | |
recls/C# | |
The recls C# mapping. | |
recls/COM | |
The recls COM mapping. | |
recls/D | |
The recls D mapping. | |
recls/Java | |
The recls Java mapping. | |
recls/Python | |
The recls/Python mapping. | |
recls/Ruby | |
The recls Ruby mapping. | |
recls.stl | |
The recls STL mapping. | |
recls API Version | |
#define | RECLS_VER_MAJOR 1 |
The major version number of RECLS. | |
#define | RECLS_VER_MINOR 8 |
The minor version number of RECLS. | |
#define | RECLS_VER_REVISION 1 |
The revision version number of RECLS. | |
#define | RECLS_VER RECLS_VER_1_8_1 |
The current composite version number of RECLS. | |
Search control functions | |
recls_rc_t | Recls_SearchFtp (recls_char_t const *host, recls_char_t const *username, recls_char_t const *password, recls_char_t const *searchRoot, recls_char_t const *pattern, recls_uint32_t flags, hrecls_t *phSrch) |
Searches a given directory for matching files of the given pattern. | |
File system functions | |
size_t | Recls_GetRoots (recls_root_t *roots, size_t cRoots) |
Retrieves the file-system roots for the current operating system. | |
size_t | Recls_GetSelectedRoots (recls_root_t *roots, size_t cRoots, recls_uint32_t flags) |
Like Recls_GetRoots(), but only returns roots of selected disk types. | |
recls_char_t const * | Recls_GetPathNameSeparator (void) |
Returns the symbol used to separate distinct path names in path name lists. | |
recls_char_t const * | Recls_GetPathSeparator (void) |
Returns the symbol used to separate the directory parts within paths. | |
recls_char_t const * | Recls_GetWildcardsAll (void) |
Returns the wildcard symbol used to represent the "all files" for the current operating system. | |
Search control functions | |
recls_rc_t | Recls_Search (recls_char_t const *searchRoot, recls_char_t const *pattern, recls_uint32_t flags, hrecls_t *phSrch) |
Searches a given directory for matching files of the given pattern. | |
recls_rc_t | Recls_SearchFeedback (recls_char_t const *searchRoot, recls_char_t const *pattern, recls_uint32_t flags, hrecls_progress_fn_t pfn, recls_process_fn_param_t param, hrecls_t *phSrch) |
Searches a given directory for matching files of the given pattern, calling back on the given progress function pointer to inform the caller as each (sub-)directory is traversed. | |
recls_rc_t | Recls_SearchProcess (recls_char_t const *searchRoot, recls_char_t const *pattern, recls_uint32_t flags, hrecls_process_fn_t pfn, recls_process_fn_param_t param) |
Searches a given directory for matching files of the given pattern, and processes them according to the given process function. | |
void | Recls_SearchClose (hrecls_t hSrch) |
Closes the given search. | |
recls_rc_t | Recls_Stat (recls_char_t const *path, recls_uint32_t flags, recls_info_t *phEntry) |
Retrieves the information for the given path. | |
Search enumeration functions | |
recls_rc_t | Recls_GetNext (hrecls_t hSrch) |
Advances the search one position. | |
recls_rc_t | Recls_GetDetails (hrecls_t hSrch, recls_info_t *phEntry) |
Retrieves the information for the current search position. | |
recls_rc_t | Recls_GetNextDetails (hrecls_t hSrch, recls_info_t *phEntry) |
Advances the search one position, and retrieves the information for the new position. | |
File entry information functions | |
void | Recls_CloseDetails (recls_info_t hEntry) |
Releases the resources associated with an entry info structure. | |
recls_rc_t | Recls_CopyDetails (recls_info_t hEntry, recls_info_t *phEntry) |
Copies an entry info structure. | |
recls_rc_t | Recls_OutstandingDetails (hrecls_t hSrch, recls_uint32_t *count) |
Reports on the number of outstanding (i.e. in client code) file entry info structures. | |
Error handling functions | |
recls_rc_t | Recls_GetLastError (hrecls_t hSrch) |
Returns the last error code associated with the given search handle. | |
size_t | Recls_GetErrorString (recls_rc_t rc, recls_char_t *buffer, size_t cchBuffer) |
Gets the error string representing the given error. | |
size_t | Recls_GetLastErrorString (hrecls_t hSrch, recls_char_t *buffer, size_t cchBuffer) |
Gets the error string representing the current error associated with the given search handle. | |
Property elicitation functions | |
size_t | Recls_GetPathProperty (recls_info_t hEntry, recls_char_t *buffer, size_t cchBuffer) |
Retrieves the full path of the given entry recls_fileinfo_t. | |
size_t | Recls_GetSearchRelativePathProperty (recls_info_t hEntry, recls_char_t *buffer, size_t cchBuffer) |
Retrieves the path of the given entry recls_fileinfo_t, relative to the search directory. | |
size_t | Recls_GetDirectoryProperty (recls_info_t hEntry, recls_char_t *buffer, size_t cchBuffer) |
Retrieves the directory of the given entry recls_fileinfo_t. | |
size_t | Recls_GetDirectoryPathProperty (recls_info_t hEntry, recls_char_t *buffer, size_t cchBuffer) |
Retrieves the directory (and drive) of the given entry recls_fileinfo_t. | |
size_t | Recls_GetSearchDirectoryProperty (recls_info_t hEntry, recls_char_t *buffer, size_t cchBuffer) |
Retrieves the directory (and drive) of the given entry recls_fileinfo_t that was used in the search resulting in the given entry. | |
size_t | Recls_GetUNCDriveProperty (recls_info_t hEntry, recls_char_t *buffer, size_t cchBuffer) |
Retrieves the UNC drive property of the given entry recls_fileinfo_t. | |
size_t | Recls_GetFileProperty (recls_info_t hEntry, recls_char_t *buffer, size_t cchBuffer) |
Retrieves the file (filename + extension) of the given entry recls_fileinfo_t. | |
size_t | Recls_GetShortFileProperty (recls_info_t hEntry, recls_char_t *buffer, size_t cchBuffer) |
Retrieves the short version of the file of the given entry recls_fileinfo_t. | |
size_t | Recls_GetFileNameProperty (recls_info_t hEntry, recls_char_t *buffer, size_t cchBuffer) |
Retrieves the filename (not including extension, if any) of the given entry recls_fileinfo_t. | |
size_t | Recls_GetFileExtProperty (recls_info_t hEntry, recls_char_t *buffer, size_t cchBuffer) |
Retrieves the file extension of the given entry recls_fileinfo_t. | |
size_t | Recls_GetDirectoryPartProperty (recls_info_t hEntry, int part, recls_char_t *buffer, size_t cchBuffer) |
Retrieves a directory part of the given entry recls_fileinfo_t. | |
recls_bool_t | Recls_IsFileReadOnly (recls_info_t hEntry) |
Returns non-zero if the file entry is read-only. | |
recls_bool_t | Recls_IsFileDirectory (recls_info_t hEntry) |
Returns non-zero if the file entry represents a directory. | |
recls_bool_t | Recls_IsFileLink (recls_info_t hEntry) |
Returns non-zero if the file entry represents a link. | |
recls_bool_t | Recls_IsFileUNC (recls_info_t hEntry) |
Returns non-zero if the file entry's path is UNC. | |
void | Recls_GetSizeProperty (recls_info_t hEntry, recls_filesize_t *size) |
Acquires the size of the file entry. | |
recls_time_t | Recls_GetCreationTime (recls_info_t hEntry) |
Returns the time the file was created. | |
recls_time_t | Recls_GetModificationTime (recls_info_t hEntry) |
Returns the time the file was last modified. | |
recls_time_t | Recls_GetLastAccessTime (recls_info_t hEntry) |
Returns the time the file was last accessed. | |
recls_time_t | Recls_GetLastStatusChangeTime (recls_info_t hEntry) |
Returns the time the file status was last changed. | |
Path functions | |
size_t | Recls_CombinePaths (recls_char_t const *path1, recls_char_t const *path2, recls_char_t *result, size_t cchResult) |
Combines two paths into one. | |
size_t | Recls_DeriveRelativePath (recls_char_t const *origin, recls_char_t const *target, recls_char_t *result, size_t cchResult) |
Determines the relative path between two paths. | |
size_t | Recls_SqueezePath (recls_char_t const *path, recls_char_t *result, size_t cchResult) |
Determines the relative path between two paths. | |
Property elicitation functions | |
void | Recls_GetDriveProperty (recls_info_t hEntry, recls_char_t *pchDrive) |
Gets the drive associated with the given file entry info structure. | |
Enumerations | |
enum | RECLS_FLAG { RECLS_F_FILES = 0x00000001, RECLS_F_DIRECTORIES = 0x00000002, RECLS_F_LINKS = 0x00000004, RECLS_F_DEVICES = 0x00000008 , RECLS_F_DIR_PROGRESS = 0x00001000, RECLS_F_RECURSIVE = 0x00010000, RECLS_F_NO_FOLLOW_LINKS = 0x00020000, RECLS_F_DIRECTORY_PARTS = 0x00040000, RECLS_F_DETAILS_LATER = 0x00080000, RECLS_F_PASSIVE_FTP = 0x00100000, RECLS_F_MARK_DIRS = 0x00200000, RECLS_F_ALLOW_REPARSE_DIRS = 0x00400000, RECLS_F_CALLBACKS_STDCALL_ON_WIN32 = 0x01000000, RECLS_F_USE_TILDE_ON_NO_SEARCHROOT = 0x04000000, FILES = RECLS_F_FILES, DIRECTORIES = RECLS_F_DIRECTORIES, LINKS = RECLS_F_LINKS, DEVICES = RECLS_F_DEVICES, TYPEMASK = RECLS_F_TYPEMASK, DIR_PROGRESS = RECLS_F_DIR_PROGRESS, RECURSIVE = RECLS_F_RECURSIVE, NO_FOLLOW_LINKS = RECLS_F_NO_FOLLOW_LINKS, DIRECTORY_PARTS = RECLS_F_DIRECTORY_PARTS, DETAILS_LATER = RECLS_F_DETAILS_LATER, PASSIVE_FTP = RECLS_F_PASSIVE_FTP, MARK_DIRS = RECLS_F_MARK_DIRS, ALLOW_REPARSE_DIRS = RECLS_F_ALLOW_REPARSE_DIRS, CALLBACKS_STDCALL_ON_WIN32 = RECLS_F_CALLBACKS_STDCALL_ON_WIN32, USE_TILDE_ON_NO_SEARCHROOT = RECLS_F_USE_TILDE_ON_NO_SEARCHROOT } |
Search flags. More... | |
enum | RECLS_ROOTS_FLAG { RECLS_ROOTS_F_FIXED_DRIVES = 0x0001, RECLS_ROOTS_F_NETWORK_DRIVES = 0x0002, RECLS_ROOTS_F_CDROM_DRIVES = 0x0004, RECLS_ROOTS_F_REMOVABLE_DRIVES = 0x0008, RECLS_ROOTS_F_RAM_DRIVES = 0x0010, FixedDrives = RECLS_ROOTS_F_FIXED_DRIVES, NetworkDrives = RECLS_ROOTS_F_NETWORK_DRIVES, CDRomDrives = RECLS_ROOTS_F_CDROM_DRIVES, RemovableDrives = RECLS_ROOTS_F_REMOVABLE_DRIVES, RamDrives = RECLS_ROOTS_F_RAM_DRIVES } |
Selected Roots flags. More... |
|
The current composite version number of RECLS.
|
|
The major version number of RECLS.
|
|
The minor version number of RECLS.
|
|
The revision version number of RECLS.
|
|
Search flags. These flags moderate the search behaviour of the Recls_Search(), Recls_SearchFeedback(), and Recls_SearchProcess() functions.
|
|
Selected Roots flags. These flags moderate the search behaviour of the Recls_GetSelectedRoots() function.
|
|
Releases the resources associated with an entry info structure.
|
|
Combines two paths into one. This function takes two path fragments and combines them to form a single path.
|
|
Copies an entry info structure.
|
|
Determines the relative path between two paths.
|
|
Returns the time the file was created.
|
|
Retrieves the information for the current search position.
|
|
Retrieves a directory part of the given entry recls_fileinfo_t.
|
|
Retrieves the directory (and drive) of the given entry recls_fileinfo_t.
|
|
Retrieves the directory of the given entry recls_fileinfo_t.
|
|
Gets the drive associated with the given file entry info structure.
|
|
Gets the error string representing the given error.
|
|
Retrieves the file extension of the given entry recls_fileinfo_t.
|
|
Retrieves the filename (not including extension, if any) of the given entry recls_fileinfo_t.
|
|
Retrieves the file (filename + extension) of the given entry recls_fileinfo_t.
|
|
Returns the time the file was last accessed.
|
|
Returns the last error code associated with the given search handle.
|
|
Gets the error string representing the current error associated with the given search handle.
|
|
Returns the time the file status was last changed.
|
|
Returns the time the file was last modified.
|
|
Advances the search one position.
|
|
Advances the search one position, and retrieves the information for the new position.
|
|
Returns the symbol used to separate distinct path names in path name lists.
puts(Recls_GetPathNameSeparator()); |
|
Retrieves the full path of the given entry recls_fileinfo_t.
|
|
Returns the symbol used to separate the directory parts within paths.
puts(Recls_GetPathSeparator()); |
|
Retrieves the file-system roots for the current operating system. It is used as follows:
recls_root_t roots[26]; size_t cRoots = Recls_GetRoots(&roots[0], 26); size_t i; for(i = 0; i < cRoots; ++i) { puts(roots[i].name); }
|
|
Retrieves the directory (and drive) of the given entry recls_fileinfo_t that was used in the search resulting in the given entry.
|
|
Retrieves the path of the given entry recls_fileinfo_t, relative to the search directory.
|
|
Like Recls_GetRoots(), but only returns roots of selected disk types.
|
|
Retrieves the short version of the file of the given entry recls_fileinfo_t.
|
|
Acquires the size of the file entry.
|
|
Retrieves the UNC drive property of the given entry recls_fileinfo_t.
|
|
Returns the wildcard symbol used to represent the "all files" for the current operating system.
puts(Recls_GetWildcardsAll()); |
|
Returns non-zero if the file entry represents a directory.
|
|
Returns non-zero if the file entry represents a link.
|
|
Returns non-zero if the file entry is read-only.
|
|
Returns non-zero if the file entry's path is UNC.
|
|
Reports on the number of outstanding (i.e. in client code) file entry info structures.
|
|
Searches a given directory for matching files of the given pattern.
|
|
Closes the given search.
|
|
Searches a given directory for matching files of the given pattern, calling back on the given progress function pointer to inform the caller as each (sub-)directory is traversed.
|
|
Searches a given directory for matching files of the given pattern.
|
|
Searches a given directory for matching files of the given pattern, and processes them according to the given process function.
|
|
Determines the relative path between two paths.
|
|
Retrieves the information for the given path.
|
|
recls Library documentation © Synesis Software Pty Ltd, 2001-2006 |