---

File-System Library (WinSTL)
[WinSTL, File-System Library]

This library provides facilities for defining and manipulating file-system objects for the Win32 API. More...

Compounds
class	basic_absolute_path
	Converts a relative path to an absolute path. More...
class	basic_current_directory
	Represents the current directory. More...
class	basic_current_directory_scope
	Current directory scoping class. More...
class	basic_file_path_buffer
	Acts as a buffer with sufficient size for any drive on the host machine. More...
class	basic_findfile_sequence
	Presents an STL-like sequence interface over the items on the file-system. More...
class	basic_findfile_sequence_const_input_iterator
	Iterator type for the basic_findfile_sequence supporting the Input Iterator concept. More...
class	basic_findfile_sequence_value_type
	Value type for the basic_findfile_sequence. More...
class	basic_findvolume_sequence
	Presents an STL-like sequence interface over the volumes on a system. More...
class	basic_findvolume_sequence_const_iterator
	Iterator type for the basic_findvolume_sequence, supporting the Input Iterator concept. More...
class	basic_findvolume_sequence_value_type
	Value type for the basic_findvolume_sequence. More...
class	basic_module_directory
	Represents the directory of a module. More...
class	basic_module_filename
	Represents a module filename. More...
class	basic_path
	Represents a path. More...
class	basic_searchpath_sequence
	Presents an STL-like sequence interface to the search path sequence for the current process. More...
class	basic_system_directory
	Represents the system directory. More...
class	basic_windows_directory
	Represents the windows directory. More...
struct	filesystem_traits
	Traits for accessing the correct file-system functions for a given character type. More...
Typedefs
typedef basic_absolute_path< ws_char_a_t, filesystem_traits< ws_char_a_t > >	absolute_path_a
	Instantiation of the basic_absolute_path template for the ANSI character type char.
typedef basic_absolute_path< ws_char_w_t, filesystem_traits< ws_char_w_t > >	absolute_path_w
	Instantiation of the basic_absolute_path template for the Unicode character type wchar_t.
typedef basic_absolute_path< TCHAR, filesystem_traits< TCHAR > >	absolute_path
	Instantiation of the basic_absolute_path template for the Win32 character type TCHAR.
typedef basic_current_directory< ws_char_a_t, filesystem_traits< ws_char_a_t > >	current_directory_a
	Instantiation of the basic_current_directory template for the ANSI character type char.
typedef basic_current_directory< ws_char_w_t, filesystem_traits< ws_char_w_t > >	current_directory_w
	Instantiation of the basic_current_directory template for the Unicode character type wchar_t.
typedef basic_current_directory< TCHAR, filesystem_traits< TCHAR > >	current_directory
	Instantiation of the basic_current_directory template for the Win32 character type TCHAR.
typedef basic_current_directory_scope< ws_char_a_t, filesystem_traits< ws_char_a_t > >	current_directory_scope_a
	Instantiation of the basic_current_directory_scope template for the ANSI character type char.
typedef basic_current_directory_scope< ws_char_w_t, filesystem_traits< ws_char_w_t > >	current_directory_scope_w
	Instantiation of the basic_current_directory_scope template for the Unicode character type wchar_t.
typedef basic_current_directory_scope< TCHAR, filesystem_traits< TCHAR > >	current_directory_scope
	Instantiation of the basic_current_directory_scope template for the Win32 character type TCHAR.
typedef basic_file_path_buffer< ws_char_a_t, processheap_allocator< ws_char_a_t > >	file_path_buffer_a
	Instantiation of the basic_file_path_buffer template for the ANSI character type char.
typedef basic_file_path_buffer< ws_char_w_t, processheap_allocator< ws_char_w_t > >	file_path_buffer_w
	Instantiation of the basic_file_path_buffer template for the Unicode character type wchar_t.
typedef basic_findfile_sequence< ws_char_a_t, filesystem_traits< ws_char_a_t > >	findfile_sequence_a
	Instantiation of the basic_findfile_sequence template for the ANSI character type char.
typedef basic_findfile_sequence< ws_char_w_t, filesystem_traits< ws_char_w_t > >	findfile_sequence_w
	Instantiation of the basic_findfile_sequence template for the Unicode character type wchar_t.
typedef basic_findfile_sequence< TCHAR, filesystem_traits< TCHAR > >	findfile_sequence
	Instantiation of the basic_findfile_sequence template for the Win32 character type TCHAR.
typedef basic_findvolume_sequence< ws_char_a_t, filesystem_traits< ws_char_a_t > >	findvolume_sequence_a
	Instantiation of the basic_findvolume_sequence template for the ANSI character type char.
typedef basic_findvolume_sequence< ws_char_w_t, filesystem_traits< ws_char_w_t > >	findvolume_sequence_w
	Instantiation of the basic_findvolume_sequence template for the Unicode character type wchar_t.
typedef basic_findvolume_sequence< TCHAR, filesystem_traits< TCHAR > >	findvolume_sequence
	Instantiation of the basic_findvolume_sequence template for the Win32 character type TCHAR.
typedef basic_module_directory< ws_char_a_t, filesystem_traits< ws_char_a_t > >	module_directory_a
	Instantiation of the basic_module_directory template for the ANSI character type char.
typedef basic_module_directory< ws_char_w_t, filesystem_traits< ws_char_w_t > >	module_directory_w
	Instantiation of the basic_module_directory template for the Unicode character type wchar_t.
typedef basic_module_directory< TCHAR, filesystem_traits< TCHAR > >	module_directory
	Instantiation of the basic_module_directory template for the Win32 character type TCHAR.
typedef basic_module_filename< ws_char_a_t, filesystem_traits< ws_char_a_t > >	module_filename_a
	Instantiation of the basic_module_filename template for the ANSI character type char.
typedef basic_module_filename< ws_char_w_t, filesystem_traits< ws_char_w_t > >	module_filename_w
	Instantiation of the basic_module_filename template for the Unicode character type wchar_t.
typedef basic_module_filename< TCHAR, filesystem_traits< TCHAR > >	module_filename
	Instantiation of the basic_module_filename template for the Win32 character type TCHAR.
typedef basic_path< ws_char_a_t, filesystem_traits< ws_char_a_t > >	path_a
	Instantiation of the basic_path template for the ANSI character type char.
typedef basic_path< ws_char_w_t, filesystem_traits< ws_char_w_t > >	path_w
	Instantiation of the basic_path template for the Unicode character type wchar_t.
typedef basic_path< TCHAR, filesystem_traits< TCHAR > >	path
	Instantiation of the basic_path template for the Win32 character type TCHAR.
typedef basic_searchpath_sequence< ws_char_a_t, filesystem_traits< ws_char_a_t > >	searchpath_sequence_a
	Instantiation of the basic_searchpath_sequence template for the ANSI character type char.
typedef basic_searchpath_sequence< ws_char_w_t, filesystem_traits< ws_char_w_t > >	searchpath_sequence_w
	Instantiation of the basic_searchpath_sequence template for the Unicode character type wchar_t.
typedef basic_searchpath_sequence< TCHAR, filesystem_traits< TCHAR > >	searchpath_sequence
	Instantiation of the basic_searchpath_sequence template for the Win32 character type TCHAR.
typedef basic_system_directory< ws_char_a_t, filesystem_traits< ws_char_a_t > >	system_directory_a
	Instantiation of the basic_system_directory template for the ANSI character type char.
typedef basic_system_directory< ws_char_w_t, filesystem_traits< ws_char_w_t > >	system_directory_w
	Instantiation of the basic_system_directory template for the Unicode character type wchar_t.
typedef basic_system_directory< TCHAR, filesystem_traits< TCHAR > >	system_directory
	Instantiation of the basic_system_directory template for the Win32 character type TCHAR.
typedef basic_windows_directory< ws_char_a_t, filesystem_traits< ws_char_a_t > >	windows_directory_a
	Instantiation of the basic_windows_directory template for the ANSI character type char.
typedef basic_windows_directory< ws_char_w_t, filesystem_traits< ws_char_w_t > >	windows_directory_w
	Instantiation of the basic_windows_directory template for the Unicode character type wchar_t.
typedef basic_windows_directory< TCHAR, filesystem_traits< TCHAR > >	windows_directory
	Instantiation of the basic_windows_directory template for the Win32 character type TCHAR.
Enumerations
enum	{ MAX_VOL_NAME = _MAX_PATH }
Functions
template<typename C> basic_absolute_path< C >	make_absolute_path (C const *path)
	This helper function makes an absolute path variable without needing to qualify the template parameter.
template<typename C> basic_path< C >	make_path (C const *path)
	This helper function makes a path variable without needing to qualify the template parameter.

---

Detailed Description

This library provides facilities for defining and manipulating file-system objects for the Win32 API.

---

Typedef Documentation

typedef basic_absolute_path<TCHAR, filesystem_traits<TCHAR> > absolute_path

Instantiation of the basic_absolute_path template for the Win32 character type TCHAR.

typedef basic_absolute_path<ws_char_a_t, filesystem_traits<ws_char_a_t> > absolute_path_a

Instantiation of the basic_absolute_path template for the ANSI character type char.

typedef basic_absolute_path<ws_char_w_t, filesystem_traits<ws_char_w_t> > absolute_path_w

Instantiation of the basic_absolute_path template for the Unicode character type wchar_t.

typedef basic_current_directory<TCHAR, filesystem_traits<TCHAR> > current_directory

Instantiation of the basic_current_directory template for the Win32 character type TCHAR.

typedef basic_current_directory<ws_char_a_t, filesystem_traits<ws_char_a_t> > current_directory_a

Instantiation of the basic_current_directory template for the ANSI character type char.

typedef basic_current_directory_scope<TCHAR, filesystem_traits<TCHAR> > current_directory_scope

Instantiation of the basic_current_directory_scope template for the Win32 character type TCHAR.

typedef basic_current_directory_scope<ws_char_a_t, filesystem_traits<ws_char_a_t> > current_directory_scope_a

Instantiation of the basic_current_directory_scope template for the ANSI character type char.

typedef basic_current_directory_scope<ws_char_w_t, filesystem_traits<ws_char_w_t> > current_directory_scope_w

Instantiation of the basic_current_directory_scope template for the Unicode character type wchar_t.

typedef basic_current_directory<ws_char_w_t, filesystem_traits<ws_char_w_t> > current_directory_w

Instantiation of the basic_current_directory template for the Unicode character type wchar_t.

typedef basic_file_path_buffer<ws_char_a_t, processheap_allocator<ws_char_a_t> > file_path_buffer_a

Instantiation of the basic_file_path_buffer template for the ANSI character type char.

typedef basic_file_path_buffer<ws_char_w_t, processheap_allocator<ws_char_w_t> > file_path_buffer_w

Instantiation of the basic_file_path_buffer template for the Unicode character type wchar_t.

typedef basic_findfile_sequence<TCHAR, filesystem_traits<TCHAR> > findfile_sequence

Instantiation of the basic_findfile_sequence template for the Win32 character type TCHAR.

typedef basic_findfile_sequence<ws_char_a_t, filesystem_traits<ws_char_a_t> > findfile_sequence_a

Instantiation of the basic_findfile_sequence template for the ANSI character type char.

typedef basic_findfile_sequence<ws_char_w_t, filesystem_traits<ws_char_w_t> > findfile_sequence_w

Instantiation of the basic_findfile_sequence template for the Unicode character type wchar_t.

typedef basic_findvolume_sequence<TCHAR, filesystem_traits<TCHAR> > findvolume_sequence

Instantiation of the basic_findvolume_sequence template for the Win32 character type TCHAR.

typedef basic_findvolume_sequence<ws_char_a_t, filesystem_traits<ws_char_a_t> > findvolume_sequence_a

Instantiation of the basic_findvolume_sequence template for the ANSI character type char.

typedef basic_findvolume_sequence<ws_char_w_t, filesystem_traits<ws_char_w_t> > findvolume_sequence_w

Instantiation of the basic_findvolume_sequence template for the Unicode character type wchar_t.

typedef basic_module_directory<TCHAR, filesystem_traits<TCHAR> > module_directory

Instantiation of the basic_module_directory template for the Win32 character type TCHAR.

typedef basic_module_directory<ws_char_a_t, filesystem_traits<ws_char_a_t> > module_directory_a

Instantiation of the basic_module_directory template for the ANSI character type char.

typedef basic_module_directory<ws_char_w_t, filesystem_traits<ws_char_w_t> > module_directory_w

Instantiation of the basic_module_directory template for the Unicode character type wchar_t.

typedef basic_module_filename<TCHAR, filesystem_traits<TCHAR> > module_filename

Instantiation of the basic_module_filename template for the Win32 character type TCHAR.

typedef basic_module_filename<ws_char_a_t, filesystem_traits<ws_char_a_t> > module_filename_a

Instantiation of the basic_module_filename template for the ANSI character type char.

typedef basic_module_filename<ws_char_w_t, filesystem_traits<ws_char_w_t> > module_filename_w

Instantiation of the basic_module_filename template for the Unicode character type wchar_t.

typedef basic_path<TCHAR, filesystem_traits<TCHAR> > path

Instantiation of the basic_path template for the Win32 character type TCHAR.

typedef basic_path<ws_char_a_t, filesystem_traits<ws_char_a_t> > path_a

Instantiation of the basic_path template for the ANSI character type char.

typedef basic_path<ws_char_w_t, filesystem_traits<ws_char_w_t> > path_w

Instantiation of the basic_path template for the Unicode character type wchar_t.

typedef basic_searchpath_sequence<TCHAR, filesystem_traits<TCHAR> > searchpath_sequence

Instantiation of the basic_searchpath_sequence template for the Win32 character type TCHAR.

typedef basic_searchpath_sequence<ws_char_a_t, filesystem_traits<ws_char_a_t> > searchpath_sequence_a

Instantiation of the basic_searchpath_sequence template for the ANSI character type char.

typedef basic_searchpath_sequence<ws_char_w_t, filesystem_traits<ws_char_w_t> > searchpath_sequence_w

Instantiation of the basic_searchpath_sequence template for the Unicode character type wchar_t.

typedef basic_system_directory<TCHAR, filesystem_traits<TCHAR> > system_directory

Instantiation of the basic_system_directory template for the Win32 character type TCHAR.

typedef basic_system_directory<ws_char_a_t, filesystem_traits<ws_char_a_t> > system_directory_a

Instantiation of the basic_system_directory template for the ANSI character type char.

typedef basic_system_directory<ws_char_w_t, filesystem_traits<ws_char_w_t> > system_directory_w

Instantiation of the basic_system_directory template for the Unicode character type wchar_t.

typedef basic_windows_directory<TCHAR, filesystem_traits<TCHAR> > windows_directory

Instantiation of the basic_windows_directory template for the Win32 character type TCHAR.

typedef basic_windows_directory<ws_char_a_t, filesystem_traits<ws_char_a_t> > windows_directory_a

Instantiation of the basic_windows_directory template for the ANSI character type char.

typedef basic_windows_directory<ws_char_w_t, filesystem_traits<ws_char_w_t> > windows_directory_w

Instantiation of the basic_windows_directory template for the Unicode character type wchar_t.

---

Enumeration Type Documentation

anonymous enum

Enumeration values: MAX_VOL_NAME  The maximum number of characters in a volume name.

---

Function Documentation

basic_absolute_path<C> make_absolute_path (  C const *    path )  [inline]

This helper function makes an absolute path variable without needing to qualify the template parameter.

basic_path<C> make_path (  C const *    path )  [inline]

This helper function makes a path variable without needing to qualify the template parameter.

STLSoft Libraries documentation © Synesis Software Pty Ltd, 2001-2004