CZipSplitNamesHandler Class Reference

#include <ZipSplitNamesHandler.h>

Inheritance diagram for CZipSplitNamesHandler:

[legend]

List of all members.

Public Types
enum	Flags { flNone = 0x00, flLast = 0x01, flExisting = 0x02 }
Public Member Functions
	CZipSplitNamesHandler ()
virtual CZipString	GetVolumeName (const CZipString &szArchiveName, ZIP_VOLUME_TYPE uCurrentVolume, ZipArchiveLib::CBitFlag flags) const =0
virtual ZIP_VOLUME_TYPE	GetVolumeNumber (const CZipString &szVolumePath) const
virtual void	Initialize (const CZipString &szArchiveName)

---

Detailed Description

Generates and parses names for split archive volumes. Base class for split names handlers.

See also:

Segmented Archives: Splitting and Spanning

---

Member Enumeration Documentation

enum CZipSplitNamesHandler::Flags

Flags for the GetVolumeName method.

Enumerator:

flNone	No special flags.
flLast	The volume is the last volume in the archive.
flExisting	The archive is an existing archive.

---

Constructor & Destructor Documentation

CZipSplitNamesHandler::CZipSplitNamesHandler

(

)

[inline]

Initializes a new instance of the CZipSplitNamesHandler class.

---

Member Function Documentation

virtual CZipString CZipSplitNamesHandler::GetVolumeName	(	const CZipString &	szArchiveName,
		ZIP_VOLUME_TYPE	uCurrentVolume,
		ZipArchiveLib::CBitFlag	flags
	)			const [pure virtual]

Returns the path for the given volume number.

Parameters:

	szArchiveName	The archive path provided when opening an archive.
	uCurrentVolume	The current volume number. The first volume number is 1.
	flags	Additional flags. It can be one or more of the Flags values.

Implemented in CZipRegularSplitNamesHandler, and CZipBinSplitNamesHandler.

virtual ZIP_VOLUME_TYPE CZipSplitNamesHandler::GetVolumeNumber

(

const CZipString &

szVolumePath

)

const [inline, virtual]

Returns the volume number for the given volume path.

Parameters:

szVolumePath

The volume path.

Returns:

The volume number parsed from the szVolumePath. The first volume number is 1. Return 0 to indicate an error during parsing.

Note:

Implementing of this method is only required for a handler for binary split archives.

Reimplemented in CZipBinSplitNamesHandler.

virtual void CZipSplitNamesHandler::Initialize

(

const CZipString &

szArchiveName

)

[inline, virtual]

Called when opening an archive.

Parameters:

szArchiveName

The archive path provided when opening an archive.

Reimplemented in CZipRegularSplitNamesHandler.

---

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

• ZipSplitNamesHandler.h