Skip Navigation Links
Skip Navigation LinksHome > ZipArchive > How to Use > API Documentation

#include <ZipPathComponent.h>

Public Types

enum  PrefixType { ptNone = 0, ptUnc = 2, ptUnicode = 4, ptUncWin = 8 }
 

Public Member Functions

 CZipPathComponent (LPCTSTR lpszFullPath)
 
CZipString GetFileDrive () const
 
CZipString GetFileExt () const
 
CZipString GetFileName () const
 
CZipString GetFilePath () const
 
CZipString GetFileTitle () const
 
CZipString GetFullPath () const
 
CZipString GetNoDrive () const
 
void SetExtension (LPCTSTR lpszExt)
 
void SetFileTitle (LPCTSTR lpszFileTitle)
 
void SetFullPath (LPCTSTR lpszFullPath)
 

Static Public Member Functions

static CZipString AddPrefix (LPCTSTR path, bool isFolder=true)
 
static void AddPrefix (CZipString &path, bool isFolder=true)
 
static void AppendSeparator (CZipString &szPath)
 
static void Combine (CZipString &szPath, LPCTSTR lpszName)
 
static bool HasEndingSeparator (const CZipString &szPath)
 
static int IsPrefixed (const CZipString &path)
 
static bool IsSeparator (TCHAR c)
 
static void RemoveSeparators (CZipString &szPath)
 
static void RemoveSeparatorsLeft (CZipString &szPath)
 

Static Public Attributes

static const TCHAR m_cSeparator
 A system specific default path separator.
 
static const CZipString PathPrefix
 

Protected Attributes

Path parts.
CZipString m_szDirectory
 The path without the filename and without path separators at the end and the beginning.
 
CZipString m_szFileTitle
 The filename without the extension.
 
CZipString m_szFileExt
 The file extension without the dot character.
 
CZipString m_szDrive
 The drive (if the system path standard uses it). It does not include a path separator at the end.
 
CZipString m_szPrefix
 The prefix (e.g. for the UNC path or Unicode path under Windows).
 

Detailed Description

Splits a file path into components.

Member Enumeration Documentation

The type of the prefix in path.

Enumerator:
ptNone 

There is no prefix present.

ptUnc 

UNC path.

ptUnicode 

Unicode path.

ptUncWin 

Windows UNC path.

Constructor & Destructor Documentation

CZipPathComponent::CZipPathComponent ( LPCTSTR  lpszFullPath)
inline

Initializes a new instance of the CZipPathComponent class.

Parameters
lpszFullPathThe full path to the file.
See Also
SetFullPath

Member Function Documentation

static CZipString CZipPathComponent::AddPrefix ( LPCTSTR  path,
bool  isFolder = true 
)
static

Adds an UNC prefix to the paths.

Parameters
pathThe path to add a prefix to.
isFoldertrue if the path points to a folder; false otherwise.
Returns
The prefixed path.
static void CZipPathComponent::AddPrefix ( CZipString &  path,
bool  isFolder = true 
)
static

Adds an UNC prefix to the paths.

Parameters
pathThe path to add a prefix to.
isFoldertrue if the path points to a folder; false otherwise.
static void CZipPathComponent::AppendSeparator ( CZipString &  szPath)
inlinestatic

Appends a path separator to szPath, if it is not already appended.

Parameters
szPathThe path to have a separator appended.
static void CZipPathComponent::Combine ( CZipString &  szPath,
LPCTSTR  lpszName 
)
inlinestatic

Combines a path information with a file name information.

Parameters
szPathProvides the path information and retrieves the result.
lpszNameThe filename to be appended to the path.
CZipString CZipPathComponent::GetFileDrive ( ) const
inline

Returns the drive of the file.

Returns
The drive without a path separator at the end.
CZipString CZipPathComponent::GetFileExt ( ) const
inline

Returns the extension of the file.

Returns
The extension without the dot character.
CZipString CZipPathComponent::GetFileName ( ) const
inline

Returns the filename.

Returns
The filename including the extension and without the path.
CZipString CZipPathComponent::GetFilePath ( ) const
inline

Returns the path part only.

Returns
The file path without the filename and without a path separator at the end.
CZipString CZipPathComponent::GetFileTitle ( ) const
inline

Returns the name of the file without the extension (and without the path).

Returns
The title of the file.
CZipString CZipPathComponent::GetFullPath ( ) const
inline

Returns the full path to the file.

Returns
The full path information including the filename.
CZipString CZipPathComponent::GetNoDrive ( ) const

Returns the full path to the file without the drive.

Returns
The path without the drive and without a path separator at the beginning.
static bool CZipPathComponent::HasEndingSeparator ( const CZipString &  szPath)
inlinestatic

Checks if szPath has a path separator appended.

Parameters
szPathThe path to be tested.
Returns
true, if szPath has a path separator at the end; false otherwise.
static int CZipPathComponent::IsPrefixed ( const CZipString &  path)
static

Returns the length of the path prefix detected.

Parameters
pathThe path to examine.
Returns
The length of the path prefix or 0, if no prefix was detected.
static bool CZipPathComponent::IsSeparator ( TCHAR  c)
inlinestatic

Returns the value indicating whether the given character is a path separator.

Parameters
cThe character to test.
Returns
true, if c is a path separator; false otherwise.
static void CZipPathComponent::RemoveSeparators ( CZipString &  szPath)
inlinestatic

Removes path separators from the end of szPath

Parameters
szPathThe path to have path separators removed.
static void CZipPathComponent::RemoveSeparatorsLeft ( CZipString &  szPath)
inlinestatic

Removes path separators from the beginning of szPath.

Parameters
szPathThe path to have path separators removed.
void CZipPathComponent::SetExtension ( LPCTSTR  lpszExt)
inline

Sets the extension.

Parameters
lpszExtThe extension to set. May contain the dot character at the beginning, but doesn't have to.
void CZipPathComponent::SetFileTitle ( LPCTSTR  lpszFileTitle)
inline

Sets the file title (the name without the extension and without the path).

Parameters
lpszFileTitleThe title to set.
void CZipPathComponent::SetFullPath ( LPCTSTR  lpszFullPath)

Sets the full path to the file.

Parameters
lpszFullPathThe full path to the file including a filename. The last element in the path is assumed to be the filename.

Member Data Documentation

const TCHAR CZipPathComponent::m_cSeparator
static

A system specific default path separator.

CZipString CZipPathComponent::m_szDirectory
protected

The path without the filename and without path separators at the end and the beginning.

CZipString CZipPathComponent::m_szDrive
protected

The drive (if the system path standard uses it). It does not include a path separator at the end.

CZipString CZipPathComponent::m_szFileExt
protected

The file extension without the dot character.

CZipString CZipPathComponent::m_szFileTitle
protected

The filename without the extension.

CZipString CZipPathComponent::m_szPrefix
protected

The prefix (e.g. for the UNC path or Unicode path under Windows).


The documentation for this class was generated from the following file:
Back To Top Up