JolietVolumeProps Class Reference

Provides an interface for setting the properties of Joliet volumes. More...

#include <PrimoBurner.h>

List of all members.

Public Member Functions
virtual const char_t *	abstractFile () const =0
	Gets the content abstract filename that is recorded in the volume descriptors of a Joliet image or data track.
virtual const char_t *	application () const =0
	Gets the Application ID that is recorded in the volume descriptors of a Joliet image or data track.
virtual const char_t *	bibliographicFile () const =0
	Gets the bibliographic information filename that is recorded in the volume descriptors of a Joliet image or data track.
virtual const char_t *	copyrightFile () const =0
	Gets the copyright note filename that is recorded in the volume descriptors of a Joliet image or data track.
virtual const char_t *	dataPreparer () const =0
	Gets the Data Preparer name that is recorded in the volume descriptors of a Joliet image or data track.
virtual bool_t	isDotAppendedToNames () const =0
	Gets the value set by setDotAppendedToNames.
virtual bool_t	isVersionAppendedToNames () const =0
	Gets the value set by setVersionAppendedToNames.
virtual const char_t *	publisher () const =0
	Gets the Publisher name that is recorded in the volume descriptors of a Joliet image or data track.
virtual void	setAbstractFile (const char_t *abstractFile)=0
	Sets the file which contains the disc contents abstract.
virtual void	setApplication (const char_t *application)=0
	Sets the name of the application which was used to create the disc.
virtual void	setBibliographicFile (const char_t *bibliographicFile)=0
	Sets the file that contains the disc bibliographic information.
virtual void	setCopyrightFile (const char_t *copyrightFile)=0
	Sets the file which contains the disc copyright notice.
virtual void	setDataPreparer (const char_t *dataPreparer)=0
	Sets the name of the entity which prepared the disc data.
virtual void	setDotAppendedToNames (bool_t dotAppended)=0
	Indicates that a trailing dot should be added to Joliet filenames that do not have a dot.
virtual void	setPublisher (const char_t *publisher)=0
	Sets the disc publisher name.
virtual void	setSystemID (const char_t *systemID)=0
	Sets the operating system on which the image will be used.
virtual void	setVersionAppendedToNames (bool_t versionAppended)=0
	Indicates that the string ';1 ' should be added to Joliet filenames.
virtual void	setVolumeCreationTime (filetime_t filetime)=0
	Sets the volume creation time.
virtual void	setVolumeLabel (const char_t *volumeLabel)=0
	Sets the image volume label.
virtual void	setVolumeSet (const char_t *volumeSet)=0
	Sets the name of the disc set.
virtual const char_t *	systemID () const =0
	Gets the Operating System ID that is recorded in the volume descriptors of a Joliet image or data track.
virtual filetime_t	volumeCreationTime () const =0
	Gets the volume creation time.
virtual const char_t *	volumeLabel () const =0
	Gets the volume label of the data image.
virtual const char_t *	volumeSet () const =0
	Gets the Volume Set name that is recorded in the volume descriptors of a Joliet image or data track.

---

Detailed Description

Provides an interface for setting the properties of Joliet volumes.

See also:

DataDisc::jolietVolumeProps

---

Member Function Documentation

virtual const char_t* abstractFile

(

)

const [pure virtual]

Gets the content abstract filename that is recorded in the volume descriptors of a Joliet image or data track.

Returns:

A null-terminated string

virtual const char_t* application

(

)

const [pure virtual]

Gets the Application ID that is recorded in the volume descriptors of a Joliet image or data track.

Returns:

A null-terminated string

virtual const char_t* bibliographicFile

(

)

const [pure virtual]

Gets the bibliographic information filename that is recorded in the volume descriptors of a Joliet image or data track.

Returns:

A null-terminated string

virtual const char_t* copyrightFile

(

)

const [pure virtual]

Gets the copyright note filename that is recorded in the volume descriptors of a Joliet image or data track.

Returns:

A null-terminated string

virtual const char_t* dataPreparer

(

)

const [pure virtual]

Gets the Data Preparer name that is recorded in the volume descriptors of a Joliet image or data track.

Returns:

A null-terminated string

virtual bool_t isDotAppendedToNames

(

)

const [pure virtual]

Gets the value set by setDotAppendedToNames.

The default value of this property is TRUE.

Returns:

TRUE if a trailing dot should be added to Joliet filenames that do not have a dot.

virtual bool_t isVersionAppendedToNames

(

)

const [pure virtual]

Gets the value set by setVersionAppendedToNames.

The default value of this property is TRUE.

Returns:

TRUE if the string ';1' will be added to Joliet filenames, FALSE otherwise.

virtual const char_t* publisher

(

)

const [pure virtual]

Gets the Publisher name that is recorded in the volume descriptors of a Joliet image or data track.

Returns:

A null-terminated string

virtual void setAbstractFile

(

const char_t *

abstractFile

)

[pure virtual]

Sets the file which contains the disc contents abstract.

Parameters:

abstractFile

A filename that follows the 8 + 3 rule The file must be placed in the root directory of the CD. Only capital letters from A to Z, digits from 0 to 9, and the following special characters\: "&!')(=*+,-/\:;><?_. (blank) are allowed.

virtual void setApplication

(

const char_t *

application

)

[pure virtual]

Sets the name of the application which was used to create the disc.

Parameters:

application

A string with maximum length of 128 characters or a filename. The filename must start with underscore ( _ ) and follows the 8 + 3 rule. The file must be placed in the root directory of the CD.

Only capital letters from A to Z, digits from 0 to 9, and the following special characters: "&!')(=*+,-/:;><?_. (blank) are allowed.

virtual void setBibliographicFile

(

const char_t *

bibliographicFile

)

[pure virtual]

Sets the file that contains the disc bibliographic information.

Parameters:

bibliographicFile

A filename that follows the 8 + 3 rule. The file must be placed in the root directory of the CD. Only capital letters from A to Z, digits from 0 to 9, and the following special characters: "&!')(=*+,-/:;><?_. (blank) are allowed.

virtual void setCopyrightFile

(

const char_t *

copyrightFile

)

[pure virtual]

Sets the file which contains the disc copyright notice.

Parameters:

copyrightFile

A filename that follows the 8 + 3 rule. The file must be placed in the root directory of the CD. Only capital letters from A to Z, digits from 0 to 9, and the following special characters\: "&!')(=*+,-/\:;><?_. (blank) are allowed.

virtual void setDataPreparer

(

const char_t *

dataPreparer

)

[pure virtual]

Sets the name of the entity which prepared the disc data.

Parameters:

dataPreparer

A string with maximum length of 128 characters or a filename. The filename must start with underscore ( _ ) and follows the 8 + 3 rule. The file must be placed in the root directory of the CD.

Only capital letters from A to Z, digits from 0 to 9, and the following special characters: "&!')(=*+,-/:;><?_. (blank) are allowed.

virtual void setDotAppendedToNames

(

bool_t

dotAppended

)

[pure virtual]

Indicates that a trailing dot should be added to Joliet filenames that do not have a dot.

The default value of this property is TRUE.

Parameters:

dotAppended

if TRUE a trailing dot should be added to Joliet filenames that do not have a dot.

Remarks:

The dot is a mandatory part of the filename according to ISO9660. However in some cases like bootable discs for Windows you may need to disable this feature to make the disc compatible with the boot loader.

virtual void setPublisher

(

const char_t *

publisher

)

[pure virtual]

Sets the disc publisher name.

Parameters:

publisher

A string with maximum length of 128 characters or a filename. The filename must start with underscore ( _ ) and follow the 8 + 3 rule. The file must be placed in the root directory of the CD. Only capital letters from A to Z, digits from 0 to 9, and the following special characters: "&!')(=*+,-/\:;><?_. (blank) are allowed.

virtual void setSystemID

(

const char_t *

systemID

)

[pure virtual]

Sets the operating system on which the image will be used.

The maximum length allowed for the system ID is 32 characters for ISO9660 images and 16 characters for Joliet images.

Parameters:

systemID

A null-terminated string. Only capital letters from A to Z, digits from 0 to 9, and the following special characters: "&!')(=*+,-/:;><?_. (blank) are allowed.

virtual void setVersionAppendedToNames

(

bool_t

versionAppended

)

[pure virtual]

Indicates that the string ';1 ' should be added to Joliet filenames.

The default value of this property is TRUE.

Parameters:

versionAppended

if TRUE the string ';1' should be added to Joliet filenames.

Remarks:

The string ';1 ' is the "file version" and according to ISO9660 is a mandatory part of the filename. However in some cases like bootable discs for Windows you may need to disable this feature to make the disc compatible with the boot loader.

virtual void setVolumeCreationTime

(

filetime_t

filetime

)

[pure virtual]

Sets the volume creation time.

The time must be set as coordinated universal time (UTC), formerly known as Greenwich Mean Time (GMT).

Parameters:

filetime

On Windows it is specified with a Win32 FILETIME structure. On OS X and Linux it is time_t. The time must be coordinated universal time (UTC), formerly known as Greenwich mean time (GMT).

virtual void setVolumeLabel

(

const char_t *

volumeLabel

)

[pure virtual]

Sets the image volume label.

Parameters:

volumeLabel

The maximum length allowed for the volume label is 32 characters. Only capital letters from A to Z, digits from 0 to 9, and the special characters _ (underscore) are allowed.

virtual void setVolumeSet

(

const char_t *

volumeSet

)

[pure virtual]

Sets the name of the disc set.

Parameters:

volumeSet

String with maximum length of 128 characters. Only capital letters from A to Z, digits from 0 to 9, and the special character _ (underscore) are allowed.

Returns:

A null-terminated string

virtual const char_t* systemID

(

)

const [pure virtual]

Gets the Operating System ID that is recorded in the volume descriptors of a Joliet image or data track.

Returns:

A null-terminated string

virtual filetime_t volumeCreationTime

(

)

const [pure virtual]

Gets the volume creation time.

The time is returned as coordinated universal time (UTC), formerly known as Greenwich Mean Time (GMT).

Returns:

A UTC time value. On Windows it is returned with a Win32 FILETIME structure. On OS X and Linux it is a time_t value.

virtual const char_t* volumeLabel

(

)

const [pure virtual]

Gets the volume label of the data image.

Returns:

A null-terminated string

virtual const char_t* volumeSet

(

)

const [pure virtual]

Gets the Volume Set name that is recorded in the volume descriptors of a Joliet image or data track.

Returns:

A null-terminated string