C/C++ User's Journal STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... ATLSTL - where the Standard Template Library meets the Active Template Library COMSTL - where the Standard Template Library meets the Component Object Model
Synesis Software InetSTL - where the Standard Template Library meets the Internet UNIXSTL - Template Software for the UNIX Operating System WinSTL - where the Standard Template Library meets the Win32 API

recls.c++
[recls]


Detailed Description

The recls C++ mapping.

It resides within the recls::cpp namespace.

This mapping contains the classes - FileSearch, FileEntry, and DirectoryParts - which provide a simple C++ wrapping over the recls API, handling resource management, and providing easy-to-use object access to the search results.


Classes

class  DirectoryParts_class
 This class provides enumeration over the parts of a directory for a given file entry. More...
class  FileEntry
 This class represents a file search entry. More...
class  FileSearch
 This class provides functionality for executing a file search. More...
class  FtpSearch
 This class provides functionality for executing a file search. More...
class  Search
 This class provides functionality for executing a file search. More...

Typedefs

typedef std::string recls::cpp::string_a_t
 string_t The string type to be used in the reclspp (recls::cpp) namespace

Functions

FileEntry::char_type const * recls::cpp::c_str_ptr (FileEntry const &fe)
 String access shim.


Typedef Documentation

typedef std::string string_a_t

string_t The string type to be used in the reclspp (recls::cpp) namespace

Note:
By default string_t is defined to be std::string, but this can be overridden by specifying RECLS_CPP_STRING_HEADER, e.g. "mystring.h", and also defining RECLS_CPP_STRING_T, e.g. "my_string" which will be typedef'd to string_t


Function Documentation

FileEntry::char_type const* recls::cpp::c_str_ptr ( FileEntry const &  fe  )  [inline]

String access shim.

This returns a non-null null-terminated C-string of the given FileEntry's full path.

Parameters:
fe The FileEntry instance whose path is to be returned
Note:
This fits the STLSoft shims concept, described in this Synesis Software White Paper, and featured in the article "<a href = "http://www.cuj.com/documents/s=8681/cuj0308wilson/">Generalised String Manipulation: Access Shims and Type-tunnelling</a>", in the August 2003 issue of C/C++ User's Journal.


recls Library documentation © Synesis Software Pty Ltd, 2001-2006