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

basic_search_sequence_value_type Class Template Reference
[recls.stl]

#include <recls/stl/search_sequence.hpp>

List of all members.


Detailed Description

template<typename C, typename T>
class recls::stl::basic_search_sequence_value_type< C, T >

Value type for the basic_search_sequence.


Construction

 basic_search_sequence_value_type ()
 Default constructor.
 ~basic_search_sequence_value_type ()
 Destructor.
class_typeoperator= (class_type const &rhs)
 Copy assignment operator.

Public Types

Types
typedef C char_type
 The character type.
typedef T traits_type
 The traits type.
typedef basic_search_sequence_value_type<
C, T > 
class_type
 The current parameterisation of the type.
typedef ss_typename_type_k
traits_type::entry_type 
entry_type
 The find-data type.
typedef ss_typename_type_k
traits_type::directory_parts_type 
directory_parts_type
 The directory parts sequence type.
typedef size_t size_type
 The size type.

Public Member Functions

Attributes
string_t get_path () const
 Returns the full path of the item.
string_t get_search_relative_path () const
 Returns the path of the item, relative to the search directory.
string_t get_search_directory () const
 Returns the directory (and drive) searched resulting in the file entry.
string_t get_directory () const
 Returns the directory of the item.
string_t get_directory_path () const
 Returns the directory (+ drive) of the item.
string_t get_UNC_drive () const
 Returns the UNC drive component, if any, of the item's path.
directory_parts_type get_directory_parts () const
 Returns a sequence of directory parts of the item.
string_t get_file () const
 Returns the file (file name + extension) of the item.
string_t get_short_file () const
 Returns the short form of the filename of the item.
string_t get_filename () const
 Returns the filename of the item.
string_t get_fileext () const
 Returns the file extension of the item.
recls_bool_t is_readonly () const
 Indicates whether the file entry's path is read-only.
recls_bool_t is_directory () const
 Indicates whether the file entry's path is a directory.
recls_bool_t is_link () const
 Indicates whether the file entry's path is a link.
recls_bool_t is_UNC () const
 Indicates whether the file entry's path is UNC.
char_type const * c_str () const
 A C-string to the full path.
size_type get_full_path_length () const
 A C-string to the full path.
entry_type const & get_entry () const
 Returns a non-mutating reference to find-data.


Member Typedef Documentation

typedef C char_type

The character type.

typedef T traits_type

The traits type.

typedef basic_search_sequence_value_type<C, T> class_type

The current parameterisation of the type.

typedef ss_typename_type_k traits_type::entry_type entry_type

The find-data type.

typedef ss_typename_type_k traits_type::directory_parts_type directory_parts_type

The directory parts sequence type.

typedef size_t size_type

The size type.


Constructor & Destructor Documentation

basic_search_sequence_value_type (  ) 

Default constructor.

~basic_search_sequence_value_type (  ) 

Destructor.


Member Function Documentation

class_type& operator= ( class_type const &  rhs  ) 

Copy assignment operator.

string_t get_path (  )  const

Returns the full path of the item.

string_t get_search_relative_path (  )  const

Returns the path of the item, relative to the search directory.

string_t get_search_directory (  )  const

Returns the directory (and drive) searched resulting in the file entry.

string_t get_directory (  )  const

Returns the directory of the item.

string_t get_directory_path (  )  const

Returns the directory (+ drive) of the item.

string_t get_UNC_drive (  )  const

Returns the UNC drive component, if any, of the item's path.

directory_parts_type get_directory_parts (  )  const

Returns a sequence of directory parts of the item.

string_t get_file (  )  const

Returns the file (file name + extension) of the item.

string_t get_short_file (  )  const

Returns the short form of the filename of the item.

string_t get_filename (  )  const

Returns the filename of the item.

string_t get_fileext (  )  const

Returns the file extension of the item.

recls_bool_t is_readonly (  )  const

Indicates whether the file entry's path is read-only.

recls_bool_t is_directory (  )  const

Indicates whether the file entry's path is a directory.

recls_bool_t is_link (  )  const

Indicates whether the file entry's path is a link.

recls_bool_t is_UNC (  )  const

Indicates whether the file entry's path is UNC.

char_type const* c_str (  )  const

A C-string to the full path.

size_type get_full_path_length (  )  const

A C-string to the full path.

entry_type const& get_entry (  )  const

Returns a non-mutating reference to find-data.


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

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