CZipStringStoreSettings Class Reference

#include <ZipStringStoreSettings.h>

List of all members.

Public Member Functions

 CZipStringStoreSettings ()
bool IsStandard (int iPlatform) const
bool IsStandardCommentCodePage () const
bool IsStandardCommentCodePage (int iPlatform) 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)

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, Comments and Passwords

CZipArchive::SetStringStoreSettings.

Definition at line 44 of file ZipStringStoreSettings.h.


Constructor & Destructor Documentation

CZipStringStoreSettings::CZipStringStoreSettings (  )  [inline]

Initializes a new instance of the CZipStringStoreSettings class.

Definition at line 51 of file ZipStringStoreSettings.h.


Member Function Documentation

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

Returns the value indicating whether the current settings are standard for the given platform.

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

Definition at line 132 of file ZipStringStoreSettings.h.

bool CZipStringStoreSettings::IsStandardCommentCodePage (  )  const [inline]

Returns the value indicating whether the current comment code page is standard.

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

Definition at line 117 of file ZipStringStoreSettings.h.

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

Returns the value indicating whether the current comment code page is standard.

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

Definition at line 106 of file ZipStringStoreSettings.h.

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

Returns the value indicating whether the current filename code page is standard for the given platform.

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

Definition at line 92 of file ZipStringStoreSettings.h.

bool CZipStringStoreSettings::IsStandardNameCodePage (  )  const [inline]

Returns the value indicating whether the current filename code page is standard for the current platform.

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

Definition at line 77 of file ZipStringStoreSettings.h.

void CZipStringStoreSettings::Reset (  )  [inline]

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

See also:
Reset(int)

ZipPlatform::GetSystemID

Definition at line 160 of file ZipStringStoreSettings.h.

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

Resets the settings to their default values for the given platform.

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

Definition at line 145 of file ZipStringStoreSettings.h.

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

Sets the string store settings.

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

Definition at line 171 of file ZipStringStoreSettings.h.

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

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

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

Definition at line 62 of file ZipStringStoreSettings.h.


Member Data Documentation

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

Definition at line 181 of file ZipStringStoreSettings.h.

The current comment code page for files.

Definition at line 191 of file ZipStringStoreSettings.h.

The current filename code page.

Definition at line 186 of file ZipStringStoreSettings.h.


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

The ZipArchive Library Copyright © 2000 - 2009 Artpol Software - Tadeusz Dracz. Generated at Fri Apr 24 16:46:36 2009.