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

CZipStringStoreSettings Class Reference

#include <ZipStringStoreSettings.h>

List of all members.


Public Member Functions

 CZipStringStoreSettings ()
bool IsStandard (int iPlatform) const
bool IsStandardCommentCodePage () const
bool IsStandardNameCodePage (int iPlatform) const
bool IsStandardNameCodePage () const
void Reset ()
void Reset (int iPlatform)
void Set (UINT uFileNameCodePage, bool bStoreNameInExtraData, UINT uCommentCodePage)
void SetDefaultNameCodePage (int iPlatform)

Static Public Member Functions

static UINT GetDefaultCommentCodePage ()
static UINT GetDefaultNameCodePage ()
static UINT GetDefaultNameCodePage (int iPlatform)

Public Attributes

bool m_bStoreNameInExtraData
UINT m_uCommentCodePage
UINT m_uNameCodePage

Detailed Description

Settings used in storing strings inside archives.

See also:
Unicode Support: Using Non-English Characters in Filenames and Comments

CZipArchive::SetStringStoreSettings.

Constructor & Destructor Documentation

CZipStringStoreSettings::CZipStringStoreSettings (  )  [inline]

Initializes a new instance of the CZipStringStoreSettings class.

Member Function Documentation

static UINT CZipStringStoreSettings::GetDefaultCommentCodePage (  )  [inline, static]

Gets the default comment code page. It is not platform-dependent.

static UINT CZipStringStoreSettings::GetDefaultNameCodePage (  )  [inline, static]

Gets the default filename code page for the current platform.

Returns:
The default filename code page.

static UINT CZipStringStoreSettings::GetDefaultNameCodePage ( int  iPlatform  )  [inline, static]

Gets the default filename code page for the given platform.

Parameters:
iPlatform One of the ZipCompatibility::ZipPlatforms values.
Returns:
The default filename code page.

bool CZipStringStoreSettings::IsStandard ( int  iPlatform  )  const [inline]

Gets a value indicating whether the current settings are standard for the given platform or not.

Parameters:
iPlatform One of the ZipCompatibility::ZipPlatforms values.
Returns:
true, if the current settings are standard; false otherwise.

bool CZipStringStoreSettings::IsStandardCommentCodePage (  )  const [inline]

Gets a value indicating whether the current comment code page is standard.

Returns:
true, if the current comment code page is standard; false otherwise.

bool CZipStringStoreSettings::IsStandardNameCodePage ( int  iPlatform  )  const [inline]

Gets a value indicating whether the current filename code page is standard for the given platform or not.

Parameters:
iPlatform One of the ZipCompatibility::ZipPlatforms values.
Returns:
true, if the current filename code page is standard; false otherwise.

bool CZipStringStoreSettings::IsStandardNameCodePage (  )  const [inline]

Gets a value indicating whether the current filename code page is standard for the current platform or not.

Returns:
true, if the current filename code page is standard; false otherwise.
See also:
ZipPlatform::GetSystemID

void CZipStringStoreSettings::Reset (  )  [inline]

Reset the settings to its default values for the current platform.

See also:
Reset(int)

ZipPlatform::GetSystemID

void CZipStringStoreSettings::Reset ( int  iPlatform  )  [inline]

Reset the settings to its default values for the given platform.

Parameters:
iPlatform One of the ZipCompatibility::ZipPlatforms values.
See also:
Reset

void CZipStringStoreSettings::Set ( UINT  uFileNameCodePage,
bool  bStoreNameInExtraData,
UINT  uCommentCodePage 
) [inline]

Sets the string store settings.

See also:
CZipArchive::SetStringStoreSettings(UINT, bool, UINT)

void CZipStringStoreSettings::SetDefaultNameCodePage ( int  iPlatform  )  [inline]

Sets the default filename code page depening on the given platform.

Parameters:
iPlatform One of the ZipCompatibility::ZipPlatforms values.

Member Data Documentation

bool CZipStringStoreSettings::m_bStoreNameInExtraData

If true, the converted filenames are stored in extra field in the archive.

UINT CZipStringStoreSettings::m_uCommentCodePage

The current comment code page.

UINT CZipStringStoreSettings::m_uNameCodePage

The current filename code page.

The documentation for this class was generated from the following file:
Copyright © 2000 - 2007 Artpol Software - Tadeusz Dracz
Back To Top Up