Provides an interface for setting the properties of a bootable disc.
More...
#include <pb_api.h>
|
| virtual BootEmulation::Enum | emulation () const =0 |
| | Gets the current boot emulation mode.
|
| |
| virtual const char_t * | imageFile () const =0 |
| | Gets the image file that is used to create a bootable disc.
|
| |
| virtual uint16_t | loadSegment () const =0 |
| | Gets the load segment for the initial boot image.
|
| |
| virtual BootPlatformID::Enum | platformID ()=0 |
| | Gets the current boot platform identifier.
|
| |
| virtual uint16_t | sectorCount () const =0 |
| | Gets the number of boot sectors that the system will load from disc at boot time.
|
| |
| virtual void | setEmulation (BootEmulation::Enum bootEmulation)=0 |
| | Sets the boot media type that should be emulated when a bootable disc is created.
|
| |
| virtual void | setImageFile (const char_t *filename)=0 |
| | The SetBootImageFile method sets the image file that should be used to create a bootable disc.
|
| |
| virtual void | setLoadSegment (uint16_t loadSegment)=0 |
| | Sets the load segment for the initial boot image.
|
| |
| virtual void | setPlatformID (BootPlatformID::Enum platformID)=0 |
| | The setBootPlatformID method sets the platform identifier that identifies the operating system architecture that the boot image supports.
|
| |
| virtual void | setSectorCount (uint16_t sectorCount)=0 |
| | Sets the number of boot sectors that the system should load from disc at boot time.
|
| |
Provides an interface for setting the properties of a bootable disc.
The boot properties are used only if the disc is set as bootable. The boot properties must be set before calling DataDisc::writeToDisc and DataDisc::createImageFile.
- See also
- DataDisc::setBootable
-
DataDisc::bootProps
◆ emulation()
Gets the current boot emulation mode.
- Returns
- a constant from the BootEmulation enum.
◆ imageFile()
| virtual const char_t * imageFile |
( |
| ) |
const |
|
pure virtual |
Gets the image file that is used to create a bootable disc.
- Returns
- A zero terminated string containing the name of the image file.
◆ loadSegment()
| virtual uint16_t loadSegment |
( |
| ) |
const |
|
pure virtual |
Gets the load segment for the initial boot image.
- Returns
- Load segment address
◆ platformID()
Gets the current boot platform identifier.
- Returns
- A constant from the BootPlatformID enumeration.
◆ sectorCount()
| virtual uint16_t sectorCount |
( |
| ) |
const |
|
pure virtual |
Gets the number of boot sectors that the system will load from disc at boot time.
- Returns
- The number of boot sectors
◆ setEmulation()
Sets the boot media type that should be emulated when a bootable disc is created.
See BootEmulation for a list of the available boot emulation types.
- Parameters
-
- See also
- setImageFile
-
BootEmulation
◆ setImageFile()
| virtual void setImageFile |
( |
const char_t * |
filename | ) |
|
|
pure virtual |
The SetBootImageFile method sets the image file that should be used to create a bootable disc.
The image file should be compatible with the boot emulation set using the SetBootEmulation method: 'Floppy 1.2MB', 'Floppy 1.44MB', 'Floppy 2.88MB' or 'No emulation'.
- Parameters
-
| filename | a file that should be used as a boot image file on a bootable CD/DVD. |
- See also
- setEmulation
◆ setLoadSegment()
| virtual void setLoadSegment |
( |
uint16_t |
loadSegment | ) |
|
|
pure virtual |
Sets the load segment for the initial boot image.
If this value is 0 the system will use the traditional segment of 7C0. If this value is non-zero the system will use the specified segment. This applies to x86 architectures only.
- Parameters
-
| loadSegment | Load segment address |
◆ setPlatformID()
The setBootPlatformID method sets the platform identifier that identifies the operating system architecture that the boot image supports.
See BootPlatformID::Enum for a list of the available boot platform identifier types. The default PlatformID is x86.
- Parameters
-
- See also
- setImageFile
◆ setSectorCount()
| virtual void setSectorCount |
( |
uint16_t |
sectorCount | ) |
|
|
pure virtual |
Sets the number of boot sectors that the system should load from disc at boot time.
This is the number of sectors the system will store at Load Segment during the initial boot procedure. The default value of BootSectorCount is 1.
- Parameters
-
| sectorCount | The number of boot sectors |