---

basic_file_path_buffer Class Template Reference
[File-System Library (WinSTL)]

Acts as a buffer with sufficient size for any drive on the host machine. More...

#include <winstl_file_path_buffer.h>

List of all members.

Public Types
typedef basic_file_path_buffer< C, A >	class_type
	The current parameterisation of the type.
typedef buffer_type::value_type	value_type
	The value type.
typedef value_type &	reference
	The reference type.
typedef value_type const &	const_reference
	The non-mutating (const) reference type.
typedef buffer_type::size_type	size_type
	The size type.
Public Methods
	basic_file_path_buffer ()
	Default constructor.
value_type const *	c_str () const
	Returns a pointer to a nul-terminated string.
reference	operator[] (size_t index)
	Returns a mutable (non-const) pointer to the internal buffer.
const_reference	operator[] (size_t index) const
	Returns a non-mutable (const) pointer to the internal buffer.
size_type	size () const
	Returns the size of the internal buffer.
Static Public Methods
void	refresh () winstl_throw_0()
	Causes the drives to be examined again for the next instance.

---

Detailed Description

template<typename C, typename A = processheap_allocator<C>>
class winstl::basic_file_path_buffer< C, A >

Acts as a buffer with sufficient size for any drive on the host machine.

This class is a non-template class primarily so that separate instantiations are not created for each instantiation of the basic_file_path_buffer.

This class provides a simple function, which is to provide the maximum path length for the host. This information is then cached due to the static nature of the get_drivesvar_() method, although it can be reset by calling the refresh() method on the buffer class.

Parameters:

C	The character type
A	The allocator type
CCH	The size of the internal member path structure. On translators that support default template arguments this default to (1 + _MAX_PATH)

---

Member Typedef Documentation

typedef basic_file_path_buffer<C, A> class_type

The current parameterisation of the type.

typedef value_type const& const_reference

The non-mutating (const) reference type.

typedef value_type& reference

The reference type.

typedef buffer_type::size_type size_type

The size type.

typedef buffer_type::value_type value_type

The value type.

---

Constructor & Destructor Documentation

basic_file_path_buffer (    )  [inline]

Default constructor.

---

Member Function Documentation

value_type const* c_str (    )  const [inline]

Returns a pointer to a nul-terminated string.

const_reference operator[] (  size_t    index )  const [inline]

Returns a non-mutable (const) pointer to the internal buffer.

reference operator[] (  size_t    index )  [inline]

Returns a mutable (non-const) pointer to the internal buffer.

void refresh (    )  [inline, static]

Causes the drives to be examined again for the next instance. Deprecated:

size_type size (    )  const [inline]

Returns the size of the internal buffer.

---

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

• winstl_file_path_buffer.h

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