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

ZipArchiveLib::CBitFlag Struct Reference

#include <BitFlag.h>

List of all members.

Public Member Functions

 CBitFlag ()
 CBitFlag (int value)
void Change (int flags, bool set)
bool ChangeWithCheck (int flags, bool set)
void Clear (int flags)
bool ClearWithCheck (int flags)
bool IsSetAll (int flags) const
bool IsSetAny (int flags) const
 operator int () const
CBitFlagoperator= (const CBitFlag &flag)
bool operator== (const CBitFlag &flag)
bool operator== (int value)
void Set (int flags)
bool SetWithCheck (int flags)

Public Attributes

int m_value

Detailed Description

Provides functionality for bit operations on an integer value.


Constructor & Destructor Documentation

ZipArchiveLib::CBitFlag::CBitFlag (  ) [inline]

Initializes a new instance of the CBitFlag class.

ZipArchiveLib::CBitFlag::CBitFlag ( int  value ) [inline]

Initializes a new instance of the CBitFlag class.

Parameters:
valueThe initial value.

Member Function Documentation

void ZipArchiveLib::CBitFlag::Change ( int  flags,
bool  set 
) [inline]

Changes the given flags.

Parameters:
flagsThe flags to change.
setIf true, the flags will be set; otherwise the flags will be cleared.
bool ZipArchiveLib::CBitFlag::ChangeWithCheck ( int  flags,
bool  set 
) [inline]

Changes the given flags and examines if this caused a modification to the current object.

Parameters:
flagsThe flags to change.
setIf true, the flags will be set; otherwise the flags will be cleared.
Returns:
true, if the operation caused a modification; false otherwise.
void ZipArchiveLib::CBitFlag::Clear ( int  flags ) [inline]

Clears the given flags.

Parameters:
flagsThe flags to clear.
bool ZipArchiveLib::CBitFlag::ClearWithCheck ( int  flags ) [inline]

Clears the given flags and examines if this caused a modification to the current object.

Parameters:
flagsThe flags to clear.
Returns:
true, if the operation caused modification; false otherwise.
bool ZipArchiveLib::CBitFlag::IsSetAll ( int  flags ) const [inline]

Returns the value indicating whether all of the given flags are set.

Parameters:
flagsThe flags to examine.
Returns:
true, if all of the given flags are set; false otherwise.
bool ZipArchiveLib::CBitFlag::IsSetAny ( int  flags ) const [inline]

Returns the value indicating whether any of the given flags is set.

Parameters:
flagsThe flags to examine.
Returns:
true, if any of the given flags is set; false otherwise.
ZipArchiveLib::CBitFlag::operator int (  ) const [inline]

Returns the current value.

void ZipArchiveLib::CBitFlag::Set ( int  flags ) [inline]

Sets the given flags.

Parameters:
flagsThe flags to set.
bool ZipArchiveLib::CBitFlag::SetWithCheck ( int  flags ) [inline]

Sets the given flags and examines if this caused a modification to the current object.

Parameters:
flagsThe flags to set.
Returns:
true, if the operation caused modification; false otherwise.

Member Data Documentation

The current value.


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