Public Member Functions | Public Attributes | List of all members
CZipStringStoreSettings Class Reference

#include <ZipStringStoreSettings.h>

Public Member Functions

 CZipStringStoreSettings ()
 
bool IsStandard (int iPlatform) const
 
bool IsStandardCommentCodePage (int iPlatform) const
 
bool IsStandardCommentCodePage () const
 
bool IsStandardNameCodePage () const
 
bool IsStandardNameCodePage (int iPlatform) const
 
void Reset (int iPlatform)
 
void Reset ()
 
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 52 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
iPlatformOne of the ZipCompatibility::ZipPlatforms values.
Returns
true, if the current settings are standard; false otherwise.

Definition at line 133 of file ZipStringStoreSettings.h.

bool CZipStringStoreSettings::IsStandardCommentCodePage ( int  iPlatform) const
inline

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

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

Definition at line 107 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 118 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 78 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
iPlatformOne of the ZipCompatibility::ZipPlatforms values.
Returns
true, if the current filename code page is standard; false otherwise.

Definition at line 93 of file ZipStringStoreSettings.h.

void CZipStringStoreSettings::Reset ( int  iPlatform)
inline

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

Parameters
iPlatformOne of the ZipCompatibility::ZipPlatforms values.
See Also
Reset

Definition at line 146 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 161 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 172 of file ZipStringStoreSettings.h.

void CZipStringStoreSettings::SetDefaultNameCodePage ( int  iPlatform)
inline

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

Parameters
iPlatformOne of the ZipCompatibility::ZipPlatforms values.

Definition at line 63 of file ZipStringStoreSettings.h.

Member Data Documentation

bool CZipStringStoreSettings::m_bStoreNameInExtraData

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

Definition at line 182 of file ZipStringStoreSettings.h.

UINT CZipStringStoreSettings::m_uCommentCodePage

The current comment code page for files.

Definition at line 192 of file ZipStringStoreSettings.h.

UINT CZipStringStoreSettings::m_uNameCodePage

The current filename code page.

Definition at line 187 of file ZipStringStoreSettings.h.


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

The ZipArchive Library Copyright © 2000 - 2022 Artpol Software - Tadeusz Dracz. Generated at Sat Dec 17 2022 19:57:04.