IFileSystemImage2::get_BootImageOptionsArray method (imapi2fs.h)

Article
02/22/2024

Retrieves the boot option array that will be utilized to generate the file system image.

Syntax

HRESULT get_BootImageOptionsArray(
  [out] SAFEARRAY **pVal
);

Parameters

[out] pVal

Pointer to a boot option array that contains a list of IBootOptions interfaces of boot images used to generate the file system image. Each element of the list is a VARIANT of 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_POINTER	Pointer is not valid. Value: 0x80004003
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 will be a one-dimensional array. If a boot image is not specified, a zero-sized array will be returned.

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