IFileSystemImage2::put_BootImageOptionsArray method (imapi2fs.h)

Article
10/13/2021

Sets the boot option array that will be utilized to generate the file system image. Unlike IFileSystemImage::put_BootImageOptions, this method will not create a complete copy of each boot options array element, but instead use references to each element.

Syntax

HRESULT put_BootImageOptionsArray(
  [in] SAFEARRAY *newVal
);

Parameters

[in] newVal

List of IBootOptions interfaces of the boot images that will be utilized to generate the file system image. Each element of the list is a VARIANT of the type VT_DISPATCH.

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_NOINTERFACE	No such interface supported. Value: 0x80004002
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

The SAFEARRAY must be a one dimensional array. A zero-size array is allowed, but it will result in a regular, non-bootable disc.

The boot images sequence on the disc will match the sequence specified in the SAFEARRAY. Both put_BootImageOptionsArray and put_BootImageOptions are used for specifying the boot image, the latter function being invoked before the disc image created takes effect.

The get_BootImageOptionsArray and get_BootImageOptions functions will retrieve the result of the last calls of put_BootImageOptionsArray or put_BootImageOptions. The use of these functions should be synchronized.

Requirements

Requirement	Value
Minimum supported client	Windows Vista with SP1 [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	imapi2fs.h