IFileSystemImage::ImportFileSystem method (imapi2fs.h)

Article
10/13/2021

Imports the default file system on the current disc.

Syntax

HRESULT ImportFileSystem(
  [out] FsiFileSystems *importedFileSystem
);

Parameters

[out] importedFileSystem

Identifies the imported file system. For possible values, see the FsiFileSystems enumeration type.

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_MULTISESSION_NOT_SET	MultisessionInterfaces property must be set prior calling this method. Value: 0xC0AAB15D
IMAPI_E_EMPTY_DISC	Optical media is empty. Value: 0xC0AAB150
IMAPI_E_NO_SUPPORTED_FILE_SYSTEM	The specified disc does not contain one of the supported file systems. Value: 0xC0AAB151 Note The file systems are likely supported for the operation, but at the low levels, IMAPI2 when calling ImportFileSystem, it has generic exception/error handling and reports back error 0xC0AAB151. If the disc is not acquired for exclusive access or otherwise access denied, this error won't be reported.
IMAPI_E_BOOT_OBJECT_CONFLICT	A boot object can only be included in an initial disc image. Value: 0xC0AAB149
E_OUTOFMEMORY	Failed to allocate the required memory. Value: 0x8007000E
IMAPI_E_IMAGE_TOO_BIG	Value specified for FreeMediaBlocks property is too small for estimated image size based on current data. Value: 0xC0AAB121
IMAPI_E_INVALID_PARAM	The value specified for parameter %1!ls! is not valid. Value: 0xC0AAB101
IMAPI_E_NO_COMPATIBLE_MULTISESSION_TYPE	IMAPI supports none of the multisession type(s) provided on the current media. Value: 0xC0AAB15C Note IFileSystemImage::ImportFileSystem method returns this error if there is no media in the recording device.
IMAPI_E_INCOMPATIBLE_PREVIOUS_SESSION	Operation failed because of incompatible layout of the previous session imported from the medium. Value: 0xC0AAB133

Remarks

You must call IFileSystemImage::put_MultisessionInterfaces prior to calling IFileSystemImage::ImportFileSystem. Additionally, it is recommended that IDiscFormat2::get_MediaHeuristicallyBlank is called before IFileSystemImage::put_MultisessionInterfaces to verify that the media is not blank.

If the disc contains more than one file system, only one file system is imported. This method chooses the file system to import in the following order: UDF, Joliet, ISO 9660. The import includes transferring directories and files to the in-memory file system structure.

You may call this method at any time during the construction of the in-memory file system. If, during import, a file or directory already exists in the in-memory copy, the in-memory version will be retained; the imported file will be discarded.

To determine which file system is the default file system for the disc, call the IFileSystemImage::GetDefaultFileSystemForImport method.

This method only reads the file information. If the item is a file, the file data is copied when calling IFsiDirectoryItem::AddFile, IFsiDirectoryItem::AddTree, or IFsiDirectoryItem::Add method.

This method returns IMAPI_E_NO_SUPPORTED_FILE_SYSTEM if a supported file system is not found in the last session. Additionally, this method returns IMAPI_E_INCOMPATIBLE_PREVIOUS_SESSION if the layout of the file system in the last session is incompatible with the layout used by IMAPI for the creation of requested file systems for the result image. For more details see the IFileSystemImage::put_FileSystemsToCreate method documentation.

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