IBootOptions::AssignBootImage method (imapi2fs.h)

Article
02/22/2024

Sets the data stream that contains the boot image.

Syntax

HRESULT AssignBootImage(
  [in] IStream *newVal
);

Parameters

[in] newVal

An IStream interface of the data stream that contains the boot image.

Return value

S_OK is returned on success, but other success codes may be returned as a result of implementation. The following error codes are commonly returned on operation failure, but do not represent the only possible error values:

Return code	Description
E_POINTER	Pointer is not valid. Value: 0x80004003
IMAPI_E_BOOT_IMAGE_DATA	The boot object could not be added to the image. Value: 0xC0AAB142

Remarks

If the size of the newly assigned boot image is either 1.2, 1.44. or 2.88 MB, this method will automatically adjust the EmulationType value to the respective "floppy" type value. It is, however, possible to override the default or previously assigned EmulationType value by calling the IBootOptions::put_Emulation method.

The additional specification of the platform on which to use the boot image requires the call to the IBootOptions::put_PlatformId method.

IMAPI does not include any boot images; developers must provide their own boot images.

Requirements

Requirement	Value
Minimum supported client	Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	imapi2fs.h

Share via