Skip Navigation Links
Skip Navigation LinksHome > ZipArchive > How to Use > API Documentation
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

Constructor & Destructor Documentation

CZipStringStoreSettings::CZipStringStoreSettings ( )
inline

Initializes a new instance of the CZipStringStoreSettings class.

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.
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.
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.
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
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.
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
void CZipStringStoreSettings::Reset ( )
inline

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

See Also
Reset(int)
ZipPlatform::GetSystemID
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 depending on the given platform.

Parameters
iPlatformOne of the ZipCompatibility::ZipPlatforms values.

Member Data Documentation

bool CZipStringStoreSettings::m_bStoreNameInExtraData

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

UINT CZipStringStoreSettings::m_uCommentCodePage

The current comment code page for files.

UINT CZipStringStoreSettings::m_uNameCodePage

The current filename code page.


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