DiscArchiveCallback Class Reference

Implement this interface to receive progress notifications from DiscArchive. More...

#include <PrimoBurner.h>

Inherits Reference.

List of all members.

Public Member Functions
virtual bool_t	onRequestRename (const char_t *originalLayoutPath, const char_t *newLayoutPath)
	Called by DiscArchive to ask the client code if a file can be renamed to a specific name within the layout.
virtual void	onSourceFileErrorWithPath (const char_t *sourcePath, const char_t *layoutPath, const ErrorInfo *error)
	Called when a specific file could not be accessed or read while executing DiscArchive::prepareArchive().
int32_t	release () const
	Simple implementation of primo::Reference::release.
int32_t	retain () const
	Simple implementation of primo::Reference::retain.
int32_t	retainCount () const
	Simple implementation of primo::Reference::retainCount.

---

Detailed Description

Implement this interface to receive progress notifications from DiscArchive.

See also:

DiscArchive::setCallback

DiscArchive::callback

---

Member Function Documentation

virtual bool_t onRequestRename	(	const char_t *	originalLayoutPath,
		const char_t *	newLayoutPath
	)		[virtual]

Called by DiscArchive to ask the client code if a file can be renamed to a specific name within the layout.

Parameters:

originalLayoutPath	[in] Null-terminated string of the original path to the item for which a new name is generated.
newLayoutPath	[in] Null-terminated string of the renamed item.

Remarks:

This method is called when the file's original name is longer than the maximum length possible (127 16-bit code units) or another file already exists with that name. In those cases a new file name is generated and this method is called. The new name is constructed using the following template: "<truncated_original_name>_<rename_index>.<original_extension>", where the rename_index starts from 1 and is increased each time the proposed name is declined by the client code. The original file name on the hard drive/network location/etc. will not be modified if the rename operation is approved.

Returns:

TRUE Approve renaming.

FALSE Decline renaming.

virtual void onSourceFileErrorWithPath	(	const char_t *	sourcePath,
		const char_t *	layoutPath,
		const ErrorInfo *	error
	)		[virtual]

Called when a specific file could not be accessed or read while executing DiscArchive::prepareArchive().

Parameters:

sourcePath	[in] The Actual full path of the file on the hard drive/network location/ etc, for which the error was raised.
layoutPath	[in] The path of the item within the layout, for which the error was raised. This value may be used in the DataFile::find() method to access the actual DataFile item.
error	[in] The description of the error that triggered the file error.

int32_t release

(

)

const [virtual]

Simple implementation of primo::Reference::release.

Returns:

The updated reference count.

Implements Reference.

int32_t retain

(

)

const [virtual]

Simple implementation of primo::Reference::retain.

Returns:

The updated reference count.

Implements Reference.

int32_t retainCount

(

)

const [virtual]

Simple implementation of primo::Reference::retainCount.

Returns:

The current reference count.

Implements Reference.