IFileSystemImage interface (imapi2fs.h)
Use this interface to build a file system image, set session parameter, and import or export an image.
The file system directory hierarchy is built by adding directories and files to the root or child directories.
To create an instance of this interface, call the CoCreateInstance function. Use__uuidof(MsftFileSystemImage) for the class identifier and __uuidof(IFileSystemImage) for the interface identifier.
Inheritance
The IFileSystemImage interface inherits from the IDispatch interface. IFileSystemImage also has these types of members:
Methods
The IFileSystemImage interface has these methods.
| IFileSystemImage::CalculateDiscIdentifier Retrieves a string that identifies a disc and the sessions recorded on the disc. |
| IFileSystemImage::ChooseImageDefaults Sets the default file system types and the image size based on the current media. |
| IFileSystemImage::ChooseImageDefaultsForMediaType Sets the default file system types and the image size based on the specified media type. |
| IFileSystemImage::CreateDirectoryItem Create a directory item with the specified name. |
| IFileSystemImage::CreateFileItem Create a file item with the specified name. |
| IFileSystemImage::CreateResultImage Create the result object that contains the file system and file data. |
| IFileSystemImage::Exists Checks for the existence of a given file or directory. |
| IFileSystemImage::get_BootImageOptions Retrieves the boot image that you want to add to the file system image. |
| IFileSystemImage::get_ChangePoint Retrieves the change point identifier. |
| IFileSystemImage::get_DirectoryCount Retrieves the number of directories in the file system image. |
| IFileSystemImage::get_FileCount Retrieves the number of files in the file system image. |
| IFileSystemImage::get_FileSystemsSupported Retrieves the list of file system types that a client can use to build a file system image. |
| IFileSystemImage::get_FileSystemsToCreate Retrieves the types of file systems to create when generating the result stream. |
| IFileSystemImage::get_FreeMediaBlocks Retrieves the maximum number of blocks available for the image. |
| IFileSystemImage::get_ImportedVolumeName Retrieves the volume name provided from an imported file system. |
| IFileSystemImage::get_ISO9660InterchangeLevel Retrieves the ISO9660 compatibility level to use when creating the result image. |
| IFileSystemImage::get_ISO9660InterchangeLevelsSupported Retrieves the supported ISO9660 compatibility levels. |
| IFileSystemImage::get_MultisessionInterfaces Retrieves the list of multi-session interfaces for the optical media. |
| IFileSystemImage::get_Root Retrieves the root directory item. |
| IFileSystemImage::get_SessionStartBlock Retrieves the starting block address for the recording session. |
| IFileSystemImage::get_StageFiles Indicates if the files being added to the file system image should be staged before the burn. |
| IFileSystemImage::get_StrictFileSystemCompliance Determines the compliance level for creating and developing the file-system image. (Get) |
| IFileSystemImage::get_UDFRevision Retrieves the UDF revision level of the imported file system image. |
| IFileSystemImage::get_UDFRevisionsSupported Retrieves a list of supported UDF revision levels. |
| IFileSystemImage::get_UsedBlocks Retrieves the number of blocks in use. |
| IFileSystemImage::get_UseRestrictedCharacterSet Determines if the file and directory names use a restricted character. |
| IFileSystemImage::get_VolumeName Retrieves the volume name for this file system image. |
| IFileSystemImage::get_VolumeNameISO9660 Retrieves the volume name for the ISO9660 system image. |
| IFileSystemImage::get_VolumeNameJoliet Retrieves the volume name for the Joliet system image. |
| IFileSystemImage::get_VolumeNameUDF Retrieves the volume name for the UDF system image. |
| IFileSystemImage::get_WorkingDirectory Retrieves the temporary directory in which stash files are built. |
| IFileSystemImage::GetDefaultFileSystemForImport Retrieves the file system to import by default. |
| IFileSystemImage::IdentifyFileSystemsOnDisc Retrieves a list of the different types of file systems on the optical media. |
| IFileSystemImage::ImportFileSystem Imports the default file system on the current disc. |
| IFileSystemImage::ImportSpecificFileSystem Import a specific file system from disc. |
| IFileSystemImage::LockInChangePoint Locks the file system information at the current change-point level. |
| IFileSystemImage::put_BootImageOptions 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. |
| IFileSystemImage::put_FileSystemsToCreate Sets the file systems to create when generating the result stream. |
| IFileSystemImage::put_FreeMediaBlocks Sets the maximum number of blocks available for the image. |
| IFileSystemImage::put_ISO9660InterchangeLevel Sets the ISO9660 compatibility level of the file system image. |
| IFileSystemImage::put_MultisessionInterfaces Sets the list of multi-session interfaces for the optical media. |
| IFileSystemImage::put_SessionStartBlock Sets the starting block address for the recording session. |
| IFileSystemImage::put_StageFiles Determines if the files being added to the file system image should be staged before the burn. |
| IFileSystemImage::put_StrictFileSystemCompliance Determines the compliance level for creating and developing the file-system image. (Put) |
| IFileSystemImage::put_UDFRevision Sets the UDF revision level of the file system image. |
| IFileSystemImage::put_UseRestrictedCharacterSet Determines if file and directory names should be restricted to using only CP_ANSI characters. |
| IFileSystemImage::put_VolumeName Sets the volume name for this file system image. |
| IFileSystemImage::put_WorkingDirectory Sets the temporary directory in which stash files are built. |
| IFileSystemImage::RollbackToChangePoint Reverts the image back to the specified change point. |
| IFileSystemImage::SetMaxMediaBlocksFromDevice Set maximum number of blocks available based on the capabilities of the recorder. |
Remarks
To create the CFileSystemImage object in a script, use IMAPI2.MsftFileSystemImage as the program identifier when calling CreateObject.
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
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for