IFileSystemImage::put_MultisessionInterfaces method (imapi2fs.h)

Article
02/22/2024

Sets the list of multi-session interfaces for the optical media.

Syntax

HRESULT put_MultisessionInterfaces(
  [in] SAFEARRAY *newVal
);

Parameters

[in] newVal

List of multi-session interfaces for the optical media. Each element of the list is a VARIANT whose type is VT_DISPATCH. Query the multi-session interface for its IDispatch interface and set the pdispVal member of the variant to the IDispatch interface.

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_INCOMPATIBLE_MULTISESSION_TYPE	IMAPI does not support the multisession type requested. Value: 0xC0AAB15B
IMAPI_E_IMPORT_MEDIA_NOT_ALLOWED	IMAPI does not allow multi-session with the current media type. Value: 0xC0AAB159
IMAPI_E_NO_COMPATIBLE_MULTISESSION_TYPE	IMAPI supports none of the multisession type(s) provided on the current media. Value: 0xC0AAB15C
IMAPI_E_BAD_MULTISESSION_PARAMETER	One of multisession parameters cannot be retrieved or has a wrong value. Value: 0xC0AAB162
IMAPI_E_FSI_INTERNAL_ERROR	Internal error occurred: %1!ls!. Value: 0xC0AAB100
IMAPI_E_IMPORT_SEEK_FAILURE	Cannot seek to block %1!I64d! on source disc. This value is also returned if the optical media is blank. Value: 0xC0AAB156

Note Values returned by the IUnknown::QueryInterface method may also be returned here.

Remarks

This method validates that the multi-session type is compatible. The method succeeds if either

The list contains a single derived IMultisession interface with IMultisession::put_InUse set to VARIANT_TRUE and if the multi-session type is supported on the current media and supported by the IFileSystemImage implementation.
The list contains no derived IMultisession interfaces whose IMultisession::put_InUse property is set to VARIANT_TRUE, but contains at least one derived IMultisession that is supported on current media and supported by the IFileSystemImage implementation.

Unless the media is overwritable (i.e. DVD+/-RW, BD-RE, etc..), this method will fail if the media is blank. Failure will also occur if the list contains more than one IMultisession interface whose IMultisession::put_InUse property is set to VARIANT_TRUE, or no derived IMultisession interface is supported by the IFileSystemImage implementation. Currently, only the IMultisessionSequential interface which derives from IMultisession is supported by IFileSystemImage implementation.

For an example, see Creating a Multisession 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