CZipStringStoreSettings Class Reference

#include <ZipStringStoreSettings.h>

Public Member Functions
	CZipStringStoreSettings ()
bool	IsStandard (int iPlatform) const
bool	IsStandardCommentCodePage () const
bool	IsStandardCommentCodePage (int iPlatform) const
bool	IsStandardNameCodePage () const
bool	IsStandardNameCodePage (int iPlatform) 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.

Constructor & Destructor Documentation

CZipStringStoreSettings()

CZipStringStoreSettings::CZipStringStoreSettings ( )

inline

Initializes a new instance of the CZipStringStoreSettings class.

Member Function Documentation

IsStandard()

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.

IsStandardCommentCodePage() [1/2]

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.

IsStandardCommentCodePage() [2/2]

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.

IsStandardNameCodePage() [1/2]

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

IsStandardNameCodePage() [2/2]

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.

Reset() [1/2]

void CZipStringStoreSettings::Reset ( )

inline

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

See also

Reset(int)

ZipPlatform::GetSystemID

Reset() [2/2]

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

Set()

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

inline

Sets the string store settings.

See also

CZipArchive::SetStringStoreSettings(UINT, bool, UINT)

SetDefaultNameCodePage()

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.

Member Data Documentation

m_bStoreNameInExtraData

bool CZipStringStoreSettings::m_bStoreNameInExtraData

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

m_uCommentCodePage

UINT CZipStringStoreSettings::m_uCommentCodePage

The current comment code page for files.

m_uNameCodePage

UINT CZipStringStoreSettings::m_uNameCodePage

The current filename code page.

---

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

• ZipStringStoreSettings.h