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

Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

basic_search_sequence_value_type Class Template Reference
[recls.stl]

Value type for the basic_search_sequence. More...

#include <search_sequence.hpp>

List of all members.

Construction

 basic_search_sequence_value_type ()
 Default constructor.

 basic_search_sequence_value_type (class_type const &rhs)
 ~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.


Public Methods

Attributes
string_t get_path () const
 Returns the full path of the item.

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_time_t get_creation_time () const
recls_time_t get_modification_time () const
recls_time_t get_last_access_time () const
recls_time_t get_last_status_change_time () const
recls_filesize_t get_size () const
recls_bool_t is_readonly () const
recls_bool_t is_directory () const
recls_bool_t is_link () const
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.

entry_type const & get_entry () const
 Returns a non-mutating reference to find-data.


Detailed Description

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

Value type for the basic_search_sequence.


Member Typedef Documentation

typedef C char_type
 

The character type.

typedef basic_search_sequence_value_type<C, T> class_type
 

The current parameterisation of the type.

typedef ss_typename_type_k traits_type::directory_parts_type directory_parts_type
 

The directory parts sequence type.

typedef ss_typename_type_k traits_type::entry_type entry_type
 

The find-data type.

typedef T traits_type
 

The traits type.


Constructor & Destructor Documentation

basic_search_sequence_value_type  
 

Default constructor.

basic_search_sequence_value_type class_type const &    rhs
 

~basic_search_sequence_value_type  
 

Destructor.


Member Function Documentation

char_type const* c_str  
 

A C-string to the full path.

recls_time_t get_creation_time  
 

string_t get_directory  
 

Returns the directory of the item.

directory_parts_type get_directory_parts  
 

Returns a sequence of directory parts of the item.

string_t get_directory_path  
 

Returns the directory (+ drive) of the item.

entry_type const& get_entry  
 

Returns a non-mutating reference to find-data.

string_t get_file  
 

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

string_t get_fileext  
 

Returns the file extension of the item.

string_t get_filename  
 

Returns the filename of the item.

recls_time_t get_last_access_time  
 

recls_time_t get_last_status_change_time  
 

recls_time_t get_modification_time  
 

string_t get_path  
 

Returns the full path of the item.

string_t get_short_file  
 

Returns the short form of the filename of the item.

recls_filesize_t get_size  
 

string_t get_UNC_drive  
 

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

recls_bool_t is_directory  
 

recls_bool_t is_link  
 

recls_bool_t is_readonly  
 

recls_bool_t is_UNC  
 

Indicates whether the file entry's path is UNC.

class_type& operator= class_type const &    rhs
 

Copy assignment operator.


Friends And Related Function Documentation

friend class basic_search_sequence_const_iterator< C, T, class_type > [friend]
 

Implementation.


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

recls Library documentation Synesis Software Pty Ltd, 2001-2005