Boost.AFIO    Boost C++ Libraries
Functions
Normalise path

Functions

filesystem::path boost::afio::normalise_path (path p, path_normalise type=path_normalise::dos)
 Return a normalised filesystem::path from an AFIO path.

Function Documentation

filesystem::path boost::afio::normalise_path ( path  p,
path_normalise  type = path_normalise::dos 
)

Return a normalised filesystem::path from an AFIO path.

On POSIX this passes through its input unchanged.

On Windows AFIO exclusively uses NT kernel paths which are not necessarily trivially convertible to Win32 paths. As an example, the Win32 path `C:\Foo` might be `\??\C:\Foo` or even `\Device\HarddiskVolume1\Foo`. This function will convert any NT kernel path into something which can be fed to normal Win32 APIs - a drive letter if available, else a GUID volume path, and with an extended path prefix if the path is sufficiently long. It also scans the path for characters illegal under Win32 or paths which begin with a space or end with a period, and will extended path prefix such paths as well.

Parameters:
pPath to be normalised
typeA path_normalise enum

Definition at line 657 of file afio.hpp.


January, 2014

Copyright © 2013-2014 Niall Douglas, Cork, Ireland
Copyright © 2013 Paul Kirth, California
Documentation is generated by Doxygen