IFileSystemImage::put_BootImageOptions method (imapi2fs.h)

Sets the boot image that you want to add to the file-system image. This method creates a complete copy of the passed-in boot options by copying the stream from the supplied IBootOptions interface.

Syntax

HRESULT put_BootImageOptions(
  [in] IBootOptions *newVal
);

Parameters

[in] newVal

An IBootOptions interface of the boot image that you want to add to the file-system image. Can be NULL.

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
IMAPI_E_BOOT_OBJECT_CONFLICT
A boot object can only be included in an initial disc image.

Value: 0xC0AAB149

IMAPI_E_BOOT_IMAGE_DATA
The boot object could not be added to the image.

Value: 0xC0AAB148

Remarks

You can specify a boot image only if the file system image has no previous sessions. The boot image must start at the first sector of the disc.

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

See also

IBootOptions

IFileSystemImage

IFileSystemImage::get_BootImageOptions