STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... ATLSTL - Template Software for the Active Template Library COMSTL - The Standard Template Library meets the Component Object Model .netSTL - Standard Template Library meets the Microsoft.NET Common Language Runtime InetSTL - The Standard Template Library meets WinInet MFCSTL - Template Software for the Microsoft Foundation Classes 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_module_filename Class Template Reference
[File-System Library (WinSTL)]

Represents a module filename. More...

#include <winstl_module_filename.h>

List of all members.

Public Types

typedef C char_type
 The char type.

typedef T traits_type
 The traits type.

typedef basic_module_filename<
C, T > 
class_type
 The current parameterisation of the type.

typedef ws_size_t size_type
 The size type.


Public Methods

 basic_module_filename ()
 Default constructor - represent the filename of the current process.

 basic_module_filename (HINSTANCE hinst)
 Represent the filename of the given instance.

size_type get_filename (ws_char_a_t *buffer, size_type cchBuffer) const
 Copy the module filename to the given buffer.

size_type get_filename (ws_char_w_t *buffer, size_type cchBuffer) const
 Copy the module filename to the given buffer.

char_type const * get_filename () const
 Returns a non-mutable (const) pointer to the path.

size_type length () const
 Returns the length of the converted path.

 operator char_type const * () const
 Implicit conversion to a non-mutable (const) pointer to the path.


Static Public Methods

size_type get_filename (HINSTANCE hinst, ws_char_a_t *buffer, size_type cchBuffer)
 Copy the module filename to the given buffer.

size_type get_filename (HINSTANCE hinst, ws_char_w_t *buffer, size_type cchBuffer)
 Copy the module filename to the given buffer.


Detailed Description

template<typename C, typename T = filesystem_traits<C>>
class winstl::basic_module_filename< C, T >

Represents a module filename.

Parameters:
C  The character type
T  The traits type. On translators that support default template arguments, this defaults to filesystem_traits<C>


Member Typedef Documentation

typedef C char_type
 

The char type.

typedef basic_module_filename<C, T> class_type
 

The current parameterisation of the type.

typedef ws_size_t size_type
 

The size type.

typedef T traits_type
 

The traits type.


Constructor & Destructor Documentation

basic_module_filename  
 

Default constructor - represent the filename of the current process.

basic_module_filename HINSTANCE    hinst [explicit]
 

Represent the filename of the given instance.


Member Function Documentation

char_type const* get_filename  
 

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

size_type get_filename HINSTANCE    hinst,
ws_char_w_t   buffer,
size_type    cchBuffer
[static]
 

Copy the module filename to the given buffer.

size_type get_filename HINSTANCE    hinst,
ws_char_a_t   buffer,
size_type    cchBuffer
[static]
 

Copy the module filename to the given buffer.

size_type get_filename ws_char_w_t   buffer,
size_type    cchBuffer
const
 

Copy the module filename to the given buffer.

size_type get_filename ws_char_a_t   buffer,
size_type    cchBuffer
const
 

Copy the module filename to the given buffer.

size_type length  
 

Returns the length of the converted path.

operator char_type const *   const [inline]
 

Implicit conversion to a non-mutable (const) pointer to the path.


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

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