using System; using System.Collections; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; using System.Runtime.InteropServices.ComTypes; using System.Runtime.InteropServices.CustomMarshalers; using Vanara.Collections; namespace Vanara.PInvoke { ///

Interfaces and constants for IMAPI v1 and v2.

public static partial class IMAPI { ///

Defines values for media types that the boot image is intended to emulate.

/// /// /// Other values not defined here may exist. Consumers of this enumeration should not presume this list to be the only set of valid values. /// /// For complete details of these emulation types, see the "El Torito" Bootable CD-ROM format specification at http://www.phoenix.com/docs/specscdrom.pdf. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/ne-imapi2fs-emulationtype typedef enum EmulationType { EmulationNone, // Emulation12MFloppy, Emulation144MFloppy, Emulation288MFloppy, EmulationHardDisk } ; [PInvokeData("imapi2fs.h", MSDNShortId = "NE:imapi2fs.EmulationType")] public enum EmulationType { ///

/// No emulation. The BIOS will not emulate any device type or special sector size for the CD during boot from the CD. ///

EmulationNone, ///

Emulates a 1.2 MB floppy disk.

Emulation12MFloppy, ///

Emulates a 1.44 MB floppy disk.

Emulation144MFloppy, ///

Emulates a 2.88 MB floppy disk.

Emulation288MFloppy, ///

Emulates a hard disk.

EmulationHardDisk, } ///

Defines values for recognized file systems.

// https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/ne-imapi2fs-fsifilesystems typedef enum FsiFileSystems { // FsiFileSystemNone, FsiFileSystemISO9660, FsiFileSystemJoliet, FsiFileSystemUDF, FsiFileSystemUnknown } ; [PInvokeData("imapi2fs.h", MSDNShortId = "NE:imapi2fs.FsiFileSystems")] [Flags] public enum FsiFileSystems { ///

The disc does not contain a recognized file system.

FsiFileSystemNone = 0x000000000, ///

Standard CD file system.

FsiFileSystemISO9660 = 0x000000001, ///

Joliet file system.

FsiFileSystemJoliet = 0x000000002, ///

UDF file system.

FsiFileSystemUDF = 0x000000004, ///

The disc appears to have a file system, but the layout does not match any of the recognized types.

FsiFileSystemUnknown = 0x040000000, } ///

Defines values for the file system item that was found using the IFileSystemImage::Exists method.

// https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/ne-imapi2fs-fsiitemtype typedef enum FsiItemType { FsiItemNotFound, // FsiItemDirectory, FsiItemFile } ; [PInvokeData("imapi2fs.h", MSDNShortId = "NE:imapi2fs.FsiItemType")] public enum FsiItemType { ///

The specified item was not found.

FsiItemNotFound, ///

The specified item is a directory.

FsiItemDirectory, ///

The specified item is a file.

FsiItemFile, } ///

Defines values for the operating system architecture that the boot image supports

/// /// Other values not defined here may exist. Consumers of this enumeration should not presume this list to be the only set of valid values. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/ne-imapi2fs-platformid typedef enum PlatformId { PlatformX86, // PlatformPowerPC, PlatformMac, PlatformEFI } ; [PInvokeData("imapi2fs.h", MSDNShortId = "NE:imapi2fs.PlatformId")] public enum PlatformId { ///

Intel Pentium™ series of chip sets. This entry implies a Windows operating system.

PlatformX86, ///

Apple PowerPC family.

PlatformPowerPC, ///

Apple Macintosh family.

PlatformMac, ///

EFI Family.

PlatformEFI = 0xef, } ///

Implement this interface to receive notifications of the current write operation.

// https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nn-imapi2fs-dfilesystemimageevents [PInvokeData("imapi2fs.h", MSDNShortId = "NN:imapi2fs.DFileSystemImageEvents")] [ComImport, Guid("2C941FDF-975B-59BE-A960-9A2A262853A5"), InterfaceType(ComInterfaceType.InterfaceIsDual)] public interface DFileSystemImageEvents { ///

/// Implement this method to receive progress notification of the current write operation. The notifications are sent when /// copying the content of a file or while adding directories or files to the file system image. ///

/// /// An IFileSystemImage interface of the file system image that is being written. /// This parameter is a CFileSystemImage object in a script. /// /// String that contains the full path of the file being written. /// Number of sectors copied. /// Total number of sectors in the file. /// /// Notifications are sent in response to calling one of the following methods: /// /// /// IFsiDirectoryItem::Add /// /// /// IFsiDirectoryItem::AddFile /// /// /// IFsiDirectoryItem::AddTree /// /// /// /// Notifications can also be sent when calling one of the following methods to import a UDF file system that was created using /// immediate allocation (immediate allocation means that the file data is contained within the file descriptor instead of /// having allocation descriptors in the file descriptor that point to sectors of data): /// /// /// /// IFileSystemImage::ImportFileSystem /// /// /// IFileSystemImage::ImportSpecificFileSystem /// /// /// Notification is sent: /// /// /// Once before adding the first sector of a file (copiedSectors is 0) /// /// /// For every megabyte that is written /// /// /// Once after the final write if the file did not end on a megabyte boundary /// /// /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-dfilesystemimageevents-update HRESULT Update( // IDispatch *object, BSTR currentFile, LONG copiedSectors, LONG totalSectors ); [DispId(0x100)] [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)] void Update([In, MarshalAs(UnmanagedType.IDispatch)] IFileSystemImage @object, [In, MarshalAs(UnmanagedType.BStr)] string currentFile, long copiedSectors, long totalSectors); } ///

Receives notifications of the current write operation.

[ClassInterface(ClassInterfaceType.None)] public class DFileSystemImageEventsSink : DFileSystemImageEvents { ///

Initializes a new instance of the class.

/// The delegate to assign to the event. public DFileSystemImageEventsSink(Action onUpdate) { if (onUpdate is not null) Update += onUpdate; } ///

/// Occurs on progress notifications from the current write operation. The notifications are sent when /// copying the content of a file or while adding directories or files to the file system image. ///

/// /// Notifications are sent in response to calling one of the following methods: /// /// /// IFsiDirectoryItem::Add /// /// /// IFsiDirectoryItem::AddFile /// /// /// IFsiDirectoryItem::AddTree /// /// /// /// Notifications can also be sent when calling one of the following methods to import a UDF file system that was created using /// immediate allocation (immediate allocation means that the file data is contained within the file descriptor instead of /// having allocation descriptors in the file descriptor that point to sectors of data): /// /// /// /// IFileSystemImage::ImportFileSystem /// /// /// IFileSystemImage::ImportSpecificFileSystem /// /// /// Notification is sent: /// /// /// Once before adding the first sector of a file (copiedSectors is 0) /// /// /// For every megabyte that is written /// /// /// Once after the final write if the file did not end on a megabyte boundary /// /// /// public event Action Update; void DFileSystemImageEvents.Update(IFileSystemImage @object, string currentFile, long copiedSectors, long totalSectors) => Update?.Invoke(@object, currentFile, copiedSectors, totalSectors); } ///

Use this interface to receives notifications regarding the current file system import operation.

/// This interface supports import notifications for ISO9660, Joliet and UDF file systems. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nn-imapi2fs-dfilesystemimageimportevents [PInvokeData("imapi2fs.h", MSDNShortId = "NN:imapi2fs.DFileSystemImageImportEvents")] [ComImport, Guid("D25C30F9-4087-4366-9E24-E55BE286424B"), InterfaceType(ComInterfaceType.InterfaceIsDual)] public interface DFileSystemImageImportEvents { ///

Receives import notification for every file and directory item imported from an optical medium.

/// Pointer to an IFilesystemImage3 interface of a file system image object to which data is being imported. /// /// Type of the file system currently being imported. For possible values, see the FsiFileSystems enumeration type. /// /// A string containing the name of the file or directory being imported at the moment. /// The number of directories imported so far. /// The total number of directories to be imported from the optical medium. /// The number of files imported so far. /// The total number of files to be imported from the optical medium. /// /// Notifications are sent in response to calling one of the following methods for importing a file system. /// /// /// IFileSystemImage::ImportFileSystem /// /// /// IFileSystemImage::ImportSpecificFileSystem /// /// /// UpdateImport method receives import notifications from ISO9660, Joliet and UDF file systems. A notification is sent: /// /// /// Once after every individual imported file. /// /// /// Once before every directory import begins. /// /// /// /// The totalFileItems parameter of an UpdateImport event is always set to (-1) for ISO9660 and Joliet file systems, /// because of the difficulty quickly and accurately determining the total number of files in an ISO9660/Joliet file system /// prior to import. /// /// Import notifications are generated only for files and directories, and not for associated named streams. /// If the currentItem is a directory, it contains a back slash '' at the end. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-dfilesystemimageimportevents-updateimport HRESULT // UpdateImport( IDispatch *object, FsiFileSystems fileSystem, BSTR currentItem, LONG importedDirectoryItems, LONG // totalDirectoryItems, LONG importedFileItems, LONG totalFileItems ); [DispId(0x101)] [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)] void UpdateImport([In, MarshalAs(UnmanagedType.IDispatch)] IFileSystemImage @object, FsiFileSystems fileSystem, [In, MarshalAs(UnmanagedType.BStr)] string currentItem, long importedDirectoryItems, long totalDirectoryItems, long importedFileItems, long totalFileItems); } ///

Sink implementation for .

/// [ClassInterface(ClassInterfaceType.None)] public class DFileSystemImageImportEventsSink : DFileSystemImageImportEvents { ///

Initializes a new instance of the class.

/// The delegate to call on import update. public DFileSystemImageImportEventsSink(Action onUpdateImport) { if (onUpdateImport is not null) UpdateImport += onUpdateImport; } ///

Receives import notification for every file and directory item imported from an optical medium.

/// /// Notifications are sent in response to calling one of the following methods for importing a file system. /// /// /// IFileSystemImage::ImportFileSystem /// /// /// IFileSystemImage::ImportSpecificFileSystem /// /// /// UpdateImport method receives import notifications from ISO9660, Joliet and UDF file systems. A notification is sent: /// /// /// Once after every individual imported file. /// /// /// Once before every directory import begins. /// /// /// /// The totalFileItems parameter of an UpdateImport event is always set to (-1) for ISO9660 and Joliet file systems, /// because of the difficulty quickly and accurately determining the total number of files in an ISO9660/Joliet file system /// prior to import. /// /// Import notifications are generated only for files and directories, and not for associated named streams. /// If the currentItem is a directory, it contains a back slash '' at the end. /// public event Action UpdateImport; void DFileSystemImageImportEvents.UpdateImport(IFileSystemImage @object, FsiFileSystems fileSystem, string currentItem, long importedDirectoryItems, long totalDirectoryItems, long importedFileItems, long totalFileItems) => UpdateImport?.Invoke(@object, fileSystem, currentItem, importedDirectoryItems, totalDirectoryItems, importedFileItems, totalFileItems); } ///

/// /// Use this interface to specify the boot image to add to the optical disc. A boot image contains one or more sectors of code used /// to start the computer. /// /// /// To create an instance of this interface, call the CoCreateInstance function. Use__uuidof(BootOptions) for the class /// identifier and __uuidof(IBootOptions) for the interface identifier. /// ///

/// /// This interface supports the "El Torito" Bootable CD-ROM format specification. /// To add the boot image to a file system image, call the IFileSystemImage::put_BootImageOptions method. /// To get the boot image associated with a file system image, call the IFileSystemImage::get_BootImageOptions method. /// To create the BootOptions object in a script, use IMAPI2.BootOptions as the program identifier when calling CreateObject. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nn-imapi2fs-ibootoptions [PInvokeData("imapi2fs.h", MSDNShortId = "NN:imapi2fs.IBootOptions")] [ComImport, Guid("2C941FD4-975B-59BE-A960-9A2A262853A5"), InterfaceType(ComInterfaceType.InterfaceIsDual), CoClass(typeof(BootOptions))] public interface IBootOptions { ///

Retrieves a pointer to the boot image data stream.

/// Pointer to the IStream interface associated with the boot image data stream. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ibootoptions-get_bootimage HRESULT get_BootImage( // IStream **pVal ); [DispId(1)] IStream BootImage { get; } ///

Sets an identifier that identifies the manufacturer or developer of the CD.

/// /// Identifier that identifies the manufacturer or developer of the CD. This is an ANSI string that is limited to 24 bytes. The /// string does not need to include a NULL character; however, you must set unused bytes to 0x00. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ibootoptions-put_manufacturer HRESULT // put_Manufacturer( BSTR newVal ); [DispId(2)] string Manufacturer { [return: MarshalAs(UnmanagedType.BStr)] get; set; } ///

Sets the platform identifier that identifies the operating system architecture that the boot image supports.

/// /// Identifies the operating system architecture that the boot image supports. For possible values, see the PlatformId /// enumeration type. The default value is PlatformX86 for Intel x86–based platforms. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ibootoptions-put_platformid HRESULT put_PlatformId( // PlatformId newVal ); [DispId(3)] PlatformId PlatformId { get; set; } ///

Sets the media type that the boot image is intended to emulate.

/// /// Media type that the boot image is intended to emulate. For possible values, see the EmulationType enumeration type. The /// default value is EmulationNone, which means the BIOS will not emulate any device type or special sector size for the /// CD during boot from the CD. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ibootoptions-put_emulation HRESULT put_Emulation( // EmulationType newVal ); [DispId(4)] EmulationType Emulation { get; set; } ///

Retrieves the size of the boot image.

/// Size, in bytes, of the boot image. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ibootoptions-get_imagesize HRESULT get_ImageSize( // ULONG *pVal ); [DispId(5)] uint ImageSize { get; } ///

Sets the data stream that contains the boot image.

/// An IStream interface of the data stream that contains the boot image. /// /// /// If the size of the newly assigned boot image is either 1.2, 1.44. or 2.88 MB, this method will automatically adjust the /// EmulationType value to the respective "floppy" type value. It is, however, possible to override the default or previously /// assigned EmulationType value by calling the IBootOptions::put_Emulation method. /// /// /// The additional specification of the platform on which to use the boot image requires the call to the /// IBootOptions::put_PlatformId method. /// /// IMAPI does not include any boot images; developers must provide their own boot images. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ibootoptions-assignbootimage HRESULT AssignBootImage( // IStream *newVal ); [DispId(20)] void AssignBootImage(IStream newVal); } ///

/// Use this interface to enumerate the child directory and file items for a FsiDirectoryItem object. /// To get this interface, call the IFsiDirectoryItem::get_EnumFsiItems method. ///

/// This is a EnumFsiItems object in script. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nn-imapi2fs-ienumfsiitems [PInvokeData("imapi2fs.h", MSDNShortId = "NN:imapi2fs.IEnumFsiItems")] [ComImport, InterfaceType(ComInterfaceType.InterfaceIsIUnknown), Guid("2C941FDA-975B-59BE-A960-9A2A262853A5"), CoClass(typeof(EnumFsiItems))] public interface IEnumFsiItems : ICOMEnum { ///

Retrieves a specified number of items in the enumeration sequence.

/// Number of items to retrieve. /// Array of IFsiItem interfaces. You must release each interface in rgelt when done. /// /// Number of elements returned in rgelt. You can set pceltFetched to NULL if celt is one. Otherwise, initialize the /// value of pceltFetched to 0 before calling this method. /// /// /// /// S_OK is returned when the number of requested elements (celt) are returned successfully or the number of returned items /// (pceltFetched) is less than the number of requested elements. /// /// /// 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 /// /// /// E_OUTOFMEMORY /// Failed to allocate the required memory. Value: 0x8007000E /// /// /// E_INVALIDARG /// One or more arguments are not valid. Value: 0x80070057 /// /// /// /// If there are fewer than the requested number of elements left in the sequence, it retrieves the remaining elements. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ienumfsiitems-next HRESULT Next( ULONG celt, IFsiItem // **rgelt, ULONG *pceltFetched ); [PreserveSig] HRESULT Next(uint celt, [MarshalAs(UnmanagedType.LPArray, ArraySubType = UnmanagedType.Interface, SizeParamIndex = 2)] IFsiItem[] rgelt, out uint pceltFetched); ///

Skips a specified number of items in the enumeration sequence.

/// Number of items to skip. /// /// /// 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 /// /// /// S_FALSE /// Skipped less than the number of requested elements. /// /// /// /// /// If there are fewer elements left in the sequence than the requested number of elements to skip, it skips past the last /// element in the sequence. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ienumfsiitems-skip HRESULT Skip( ULONG celt ); [PreserveSig] HRESULT Skip(uint celt); ///

Resets the enumeration sequence to the beginning.

// https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ienumfsiitems-reset HRESULT Reset(); void Reset(); ///

Creates another enumerator that contains the same enumeration state as the current one.

/// /// Receives the interface pointer to the enumeration object. If the method is unsuccessful, the value of this output variable /// is undefined. You must release ppEnum when done. /// /// /// Using this method, a client can record a particular point in the enumeration sequence, and then return to that point at a /// later time. The new enumerator supports the same interface as the original one. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ienumfsiitems-clone HRESULT Clone( IEnumFsiItems // **ppEnum ); [return: MarshalAs(UnmanagedType.Interface)] IEnumFsiItems Clone(); } ///

/// Use this interface to enumerate a collection of progress items. /// To get this interface, call the IProgressItems::get_EnumProgressItems method. ///

/// This is a EnumProgressItems object in script. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nn-imapi2fs-ienumprogressitems [PInvokeData("imapi2fs.h", MSDNShortId = "NN:imapi2fs.IEnumProgressItems")] [ComImport, Guid("2C941FD6-975B-59BE-A960-9A2A262853A5"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown), CoClass(typeof(EnumProgressItems))] public interface IEnumProgressItems : ICOMEnum { ///

Retrieves a specified number of items in the enumeration sequence.

/// Number of items to retrieve. /// Array of IProgressItem interfaces. You must release each interface in rgelt when done. /// /// Number of elements returned in rgelt. You can set pceltFetched to NULL if celt is one. Otherwise, initialize the /// value of pceltFetched to 0 before calling this method. /// /// /// /// S_OK is returned when the number of requested elements (celt) are returned successfully or the number of returned items /// (pceltFetched) is less than the number of requested elements. /// /// /// 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 /// /// /// E_OUTOFMEMORY /// Failed to allocate the required memory. Value: 0x8007000E /// /// /// E_INVALIDARG /// One or more arguments are not valid. Value: 0x80070057 /// /// /// /// If there are fewer than the requested number of elements left in the sequence, it retrieves the remaining elements. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ienumprogressitems-next HRESULT Next( ULONG celt, // IProgressItem **rgelt, ULONG *pceltFetched ); [PreserveSig] HRESULT Next(uint celt, [MarshalAs(UnmanagedType.LPArray, ArraySubType = UnmanagedType.Interface, SizeParamIndex = 2)] IProgressItem[] rgelt, out uint pceltFetched); ///

Skips a specified number of items in the enumeration sequence.

/// Number of items to skip. /// /// /// 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 /// /// /// S_FALSE /// Skipped less than the number of requested elements. /// /// /// /// /// If there are fewer elements left in the sequence than the requested number of elements to skip, it skips past the last /// element in the sequence. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ienumprogressitems-skip HRESULT Skip( ULONG celt ); [PreserveSig] HRESULT Skip(uint celt); ///

Resets the enumeration sequence to the beginning.

// https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ienumprogressitems-reset HRESULT Reset(); void Reset(); ///

Creates another enumerator that contains the same enumeration state as the current one.

/// /// Receives the interface pointer to the enumeration object. If the method is unsuccessful, the value of this output variable /// is undefined. You must release ppEnum when done. /// /// /// Using this method, a client can record a particular point in the enumeration sequence, and then return to that point at a /// later time. The new enumerator supports the same interface as the original one. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ienumprogressitems-clone HRESULT Clone( // IEnumProgressItems **ppEnum ); [return: MarshalAs(UnmanagedType.Interface)] IEnumProgressItems Clone(); } ///

/// 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. /// ///

/// /// To create the CFileSystemImage object in a script, use IMAPI2.MsftFileSystemImage as the program identifier when calling CreateObject. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nn-imapi2fs-ifilesystemimage [PInvokeData("imapi2fs.h", MSDNShortId = "NN:imapi2fs.IFileSystemImage")] [ComImport, Guid("2C941FE1-975B-59BE-A960-9A2A262853A5"), InterfaceType(ComInterfaceType.InterfaceIsDual), CoClass(typeof(MsftFileSystemImage))] public interface IFileSystemImage { ///

Retrieves the root directory item.

/// An IFsiDirectoryItem interface of the root directory item. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_root HRESULT get_Root( // IFsiDirectoryItem **pVal ); [DispId(0)] IFsiDirectoryItem Root { [return: MarshalAs(UnmanagedType.Interface)] get; } ///

Retrieves the starting block address for the recording session.

/// Starting block address for the recording session. /// /// The session starting block can be set in the following ways: /// /// /// Importing a file system automatically sets the session starting block. /// /// /// If the previous session is not imported, the client can call IFileSystemImage::put_SessionStartBlock to set this property. /// /// /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_sessionstartblock HRESULT // get_SessionStartBlock( LONG *pVal ); [DispId(1)] int SessionStartBlock { get; set; } ///

Retrieves the maximum number of blocks available for the image.

/// Number of blocks to use in creating the file system image. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_freemediablocks HRESULT // get_FreeMediaBlocks( LONG *pVal ); [DispId(2)] int FreeMediaBlocks { get; set; } ///

Set maximum number of blocks available based on the capabilities of the recorder.

/// /// An IDiscRecorder2 interface that identifies the recording device from which you want to set the maximum number of blocks available. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-setmaxmediablocksfromdevice HRESULT // SetMaxMediaBlocksFromDevice( IDiscRecorder2 *discRecorder ); [DispId(36)] void SetMaxMediaBlocksFromDevice(IDiscRecorder2 discRecorder); ///

Retrieves the number of blocks in use.

/// Estimated number of blocks used in the file-system image. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_usedblocks HRESULT // get_UsedBlocks( LONG *pVal ); [DispId(3)] int UsedBlocks { get; } ///

Retrieves or sets the volume name for this file system image.

/// String that contains the volume name for this file system image. /// To set the volume name, call the IFileSystemImage::put_VolumeName method. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_volumename HRESULT // get_VolumeName( BSTR *pVal ); [DispId(4)] string VolumeName { [return: MarshalAs(UnmanagedType.BStr)] get; set; } ///

Retrieves the volume name provided from an imported file system.

/// /// String that contains the volume name provided from an imported file system. Is NULL until a file system is imported. /// /// /// The imported volume name is provided for user information and is not automatically carried forward to subsequent sessions. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_importedvolumename HRESULT // get_ImportedVolumeName( BSTR *pVal ); [DispId(5)] string ImportedVolumeName { [return: MarshalAs(UnmanagedType.BStr)] get; } ///

Retrieves the boot image that you want to add to the file system image.

/// An IBootOptions interface of the boot image to add to the disc. Is NULL if a boot image has not been specified. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_bootimageoptions HRESULT // get_BootImageOptions( IBootOptions **pVal ); [DispId(6)] IBootOptions BootImageOptions { [return: MarshalAs(UnmanagedType.Interface)] get; set; } ///

Retrieves the number of files in the file system image.

/// Number of files in the file system image. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_filecount HRESULT get_FileCount( // LONG *pVal ); [DispId(7)] int FileCount { get; } ///

Retrieves the number of directories in the file system image.

/// Number of directories in the file system image. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_directorycount HRESULT // get_DirectoryCount( LONG *pVal ); [DispId(8)] int DirectoryCount { get; } ///

Retrieves the temporary directory in which stash files are built.

/// String that contains the path to the temporary directory. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_workingdirectory HRESULT // get_WorkingDirectory( BSTR *pVal ); [DispId(9)] string WorkingDirectory { [return: MarshalAs(UnmanagedType.BStr)] get; set; } ///

Retrieves the change point identifier.

/// Change point identifier. The identifier is a count of the changes to the file system image since its inception. /// /// /// An application can store the value of this property prior to making a change to the file system, then at a later point pass /// the value to the IFileSystemImage::RollbackToChangePoint method to revert changes since that point in development. /// /// /// An application can call the IFileSystemImage::LockInChangePoint method to lock the state of a file system image at any point /// in its development. Once a lock is set, you cannot call RollbackToChangePoint to revert the file system image to its earlier state. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_changepoint HRESULT // get_ChangePoint( LONG *pVal ); [DispId(10)] int ChangePoint { get; } ///

Determines the compliance level for creating and developing the file-system image.

/// /// Is VARIANT_TRUE if the file system images are created in strict compliance with applicable standards. /// Is VARIANT_FALSE if the compliance standards are relaxed to be compatible with IMAPI version 1.0. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_strictfilesystemcompliance // HRESULT get_StrictFileSystemCompliance( VARIANT_BOOL *pVal ); [DispId(11)] bool StrictFileSystemCompliance { [return: MarshalAs(UnmanagedType.VariantBool)] get; set; } ///

Determines if the file and directory names use a restricted character.

/// /// Is VARIANT_TRUE if the file and directory names to add to the file system image must consist of characters that map directly /// to CP_ANSI (code points 32 through 127). Otherwise, VARIANT_FALSE. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_userestrictedcharacterset // HRESULT get_UseRestrictedCharacterSet( VARIANT_BOOL *pVal ); [DispId(12)] bool UseRestrictedCharacterSet { [return: MarshalAs(UnmanagedType.VariantBool)] get; set; } ///

Retrieves the types of file systems to create when generating the result stream.

/// /// One or more file system types to create when generating the result stream. For possible values, see the FsiFileSystems /// enumeration type. /// /// /// /// To specify the file system types, call the IFileSystemImage::put_FileSystemsToCreate method. You could also call either /// IFilesystemImage::ChooseImageDefaults or IFilesystemImage::ChooseImageDefaultsForMediaType to have IMAPI choose the file /// system for you. /// /// To retrieve a list of supported file system types, call the IFileSystemImage::get_FileSystemsSupported method. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_filesystemstocreate HRESULT // get_FileSystemsToCreate( FsiFileSystems *pVal ); [DispId(13)] FsiFileSystems FileSystemsToCreate { get; set; } ///

Retrieves the list of file system types that a client can use to build a file system image.

/// /// One or more file system types that a client can use to build a file system image. For possible values, see the /// FsiFileSystems enumeration type. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_filesystemssupported HRESULT // get_FileSystemsSupported( FsiFileSystems *pVal ); [DispId(14)] FsiFileSystems FileSystemsSupported { get; } ///

Retrieves the UDF revision level of the imported file system image.

/// UDF revision level of the imported file system image. /// /// The value is encoded according to the UDF specification, except the variable size is LONG. For example, revision level 1.02 /// is represented as 0x102. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_udfrevision HRESULT // get_UDFRevision( LONG *pVal ); [DispId(37)] int UDFRevision { set; get; } ///

Retrieves a list of supported UDF revision levels.

/// /// List of supported UDF revision levels. Each element of the list is VARIANT. The variant type is VT_I4. The /// lVal member of the variant contains the revision level. /// /// /// The value is encoded according to the UDF specification, except the variable size is LONG. For example, revision level 1.02 /// is represented as 0x102. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_udfrevisionssupported HRESULT // get_UDFRevisionsSupported( SAFEARRAY **pVal ); [DispId(31)] int[] UDFRevisionsSupported { [return: MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(SafeArrayMarshaler))] get; } ///

Sets the default file system types and the image size based on the current media.

/// An IDiscRecorder2 the identifies the device that contains the current media. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-chooseimagedefaults HRESULT // ChooseImageDefaults( IDiscRecorder2 *discRecorder ); [DispId(32)] void ChooseImageDefaults(IDiscRecorder2 discRecorder); ///

Sets the default file system types and the image size based on the specified media type.

/// /// Identifies the physical media type that will receive the burn image. For possible values, see the IMAPI_MEDIA_PHYSICAL_TYPE /// enumeration type. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-chooseimagedefaultsformediatype // HRESULT ChooseImageDefaultsForMediaType( IMAPI_MEDIA_PHYSICAL_TYPE value ); [DispId(33)] void ChooseImageDefaultsForMediaType(IMAPI_MEDIA_PHYSICAL_TYPE value); ///

Retrieves the ISO9660 compatibility level to use when creating the result image.

/// Identifies the interchange level of the ISO9660 file system. /// /// For a list of supported compatibility levels, call the IFileSystemImage::get_ISO9660InterchangeLevelsSupported method. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_iso9660interchangelevel HRESULT // get_ISO9660InterchangeLevel( LONG *pVal ); [DispId(34)] int ISO9660InterchangeLevel { set; get; } ///

Retrieves the supported ISO9660 compatibility levels.

/// /// List of supported ISO9660 compatibility levels. Each item in the list is a VARIANT that identifies one supported interchange /// level. The variant type is VT_UI4. The ulVal member of the variant contains the compatibility level. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_iso9660interchangelevelssupported // HRESULT get_ISO9660InterchangeLevelsSupported( SAFEARRAY **pVal ); [DispId(38)] uint[] ISO9660InterchangeLevelsSupported { [return: MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(SafeArrayMarshaler))] get; } ///

Create the result object that contains the file system and file data.

/// /// An IFileSystemImageResult interface of the image result. /// Client applications can stream the image to media or other long-term storage devices, such as disk drives. /// /// /// /// Currently, IFileSystemImage::CreateResultImage will require disc media access as a result of a previous /// IFileSystemImage::IdentifyFileSystemsOnDisc method call. To resolve this issue, it is recommended that another /// IFileSystemImage object be created specifically for the IFileSystemImage::IdentifyFileSystemsOnDisc operation. /// /// /// The resulting stream can be saved as an ISO file if the file system is generated in a single session and has a start address /// of zero. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-createresultimage HRESULT // CreateResultImage( IFileSystemImageResult **resultStream ); [DispId(15)] IFileSystemImageResult CreateResultImage(); ///

Checks for the existence of a given file or directory.

/// String that contains the fully qualified path of the directory or file to check. /// /// Indicates if the item is a file, a directory, or does not exist. For possible values, see the FsiItemType enumeration type. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-exists HRESULT Exists( BSTR // fullPath, FsiItemType *itemType ); [DispId(16)] FsiItemType Exists([MarshalAs(UnmanagedType.BStr)] string fullPath); ///

Retrieves a string that identifies a disc and the sessions recorded on the disc.

/// /// String that contains a signature that identifies the disc and the sessions on it. This string is not guaranteed to be unique /// between discs. /// /// /// /// When layering sessions on a disc, the signature acts as a key that the client can use to ensure the session order, and to /// distinguish sessions on disc from session images that will be laid on the disc. /// /// You must call IFileSystemImage::put_MultisessionInterfaces prior to calling CalculateDiscIdentifier. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-calculatediscidentifier HRESULT // CalculateDiscIdentifier( BSTR *discIdentifier ); [DispId(18)] [return: MarshalAs(UnmanagedType.BStr)] string CalculateDiscIdentifier(); ///

Retrieves a list of the different types of file systems on the optical media.

/// /// An IDiscRecorder2 interface that identifies the recording device that contains the media. If this parameter is NULL, /// the discRecorder specified in IMultisession will be used. /// /// One or more files systems on the disc. For possible values, see FsiFileSystems enumeration type. /// /// Client applications can call IFileSystemImage::GetDefaultFileSystemForImport with the value returned by this method to /// determine the type of file system to import. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-identifyfilesystemsondisc HRESULT // IdentifyFileSystemsOnDisc( IDiscRecorder2 *discRecorder, FsiFileSystems *fileSystems ); [DispId(19)] FsiFileSystems IdentifyFileSystemsOnDisc(IDiscRecorder2 discRecorder); ///

Retrieves the file system to import by default.

/// One or more file system values. For possible values, see the FsiFileSystems enumeration type. /// /// A single file system value that identifies the default file system. The value is one of the file systems specified in fileSystems /// /// /// Use this method to identify the default file system to use with IFileSystemImage::ImportFileSystem. /// To identify the supported file systems, call the IFileSystemImage::get_FileSystemsSupported method. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-getdefaultfilesystemforimport // HRESULT GetDefaultFileSystemForImport( FsiFileSystems fileSystems, FsiFileSystems *importDefault ); [DispId(20)] FsiFileSystems GetDefaultFileSystemForImport(FsiFileSystems fileSystems); ///

Imports the default file system on the current disc.

/// Identifies the imported file system. For possible values, see the FsiFileSystems enumeration type. /// /// /// 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 documention. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-importfilesystem HRESULT // ImportFileSystem( FsiFileSystems *importedFileSystem ); [DispId(21)] FsiFileSystems ImportFileSystem(); ///

Import a specific file system from disc.

/// /// Identifies the file system to import. For possible values, see the FsiFileSystems enumeration type. /// /// /// /// You must call IFileSystemImage::put_MultisessionInterfaces prior to calling /// IFileSystemImage::ImportSpecificFileSystem. Additionally, it is recommended that /// IDiscFormat2::get_MediaHeuristicallyBlank is called before IFileSystemImage::put_MultisessionInterfaces to verify /// that the media is not blank. /// /// /// 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. /// /// /// On re-writable media (DVD+/-RW, DVDRAM, BD-RE), import or burning a second session is not support if the first session has /// an ISO9660 file system, due to file system limitations. /// /// /// 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_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 documention. If the file system specified by fileSystemToUse has /// not been found, this method returns IMAPI_E_FILE_SYSTEM_NOT_FOUND. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-importspecificfilesystem HRESULT // ImportSpecificFileSystem( FsiFileSystems fileSystemToUse ); [DispId(22)] void ImportSpecificFileSystem(FsiFileSystems fileSystemToUse); ///

Reverts the image back to the specified change point.

/// Change point that identifies the target state for rollback. /// /// /// Typically, an application calls the IFileSystemImage::get_ChangePoint method and stores the change point value prior to /// making a change to the file system. If necessary, you can pass the change point value to this method to revert changes since /// that point in development. /// /// /// An application can call the IFileSystemImage::LockInChangePoint method to lock the state of a file system image at any point /// in its development. After a lock is set, you cannot call this method to revert the file system image to its earlier state. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-rollbacktochangepoint HRESULT // RollbackToChangePoint( LONG changePoint ); [DispId(23)] void RollbackToChangePoint(int changePoint); ///

Locks the file system information at the current change-point level.

/// /// Once the change point is locked, rollback to earlier change points is not permitted. /// Locking the change point does not change the IFileSystemImage::get_ChangePoint property. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-lockinchangepoint HRESULT LockInChangePoint(); [DispId(24)] void LockInChangePoint(); ///

Create a directory item with the specified name.

/// String that contains the name of the directory item to create. /// /// An IFsiDirectoryItem interface of the new directory item. When done, call the IFsiDirectoryItem::Release method to /// release the interface. /// /// /// After setting properties on the IFsiDirectoryItem interface, call the IFsiDirectoryItem::Add method on the parent directory /// item to add it to the file system image. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-createdirectoryitem HRESULT // CreateDirectoryItem( BSTR name, IFsiDirectoryItem **newItem ); [DispId(25)] IFsiDirectoryItem CreateDirectoryItem([MarshalAs(UnmanagedType.BStr)] string name); ///

Create a file item with the specified name.

/// String that contains the name of the file item to create. /// /// An IFsiFileItem interface of the new file item. When done, call the IFsiFileItem::Release method to release the interface. /// /// /// After setting properties on the IFsiFileItem interface, call the IFsiDirectoryItem::Add method on the parent directory item /// to add it to the file system image. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-createfileitem HRESULT // CreateFileItem( BSTR name, IFsiFileItem **newItem ); [DispId(26)] IFsiFileItem CreateFileItem([MarshalAs(UnmanagedType.BStr)] string name); ///

Retrieves the volume name for the UDF system image.

/// String that contains the volume name for the UDF system image. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_volumenameudf HRESULT // get_VolumeNameUDF( BSTR *pVal ); [DispId(27)] string VolumeNameUDF { [return: MarshalAs(UnmanagedType.BStr)] get; } ///

Retrieves the volume name for the Joliet system image.

/// String that contains the volume name for the Joliet system image. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_volumenamejoliet HRESULT // get_VolumeNameJoliet( BSTR *pVal ); [DispId(28)] string VolumeNameJoliet { [return: MarshalAs(UnmanagedType.BStr)] get; } ///

Retrieves the volume name for the ISO9660 system image.

/// String that contains the volume name for the ISO9660 system image. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_volumenameiso9660 HRESULT // get_VolumeNameISO9660( BSTR *pVal ); [DispId(29)] string VolumeNameISO9660 { [return: MarshalAs(UnmanagedType.BStr)] get; } ///

Indicates if the files being added to the file system image should be staged before the burn.

/// /// VARIANT_TRUE if the files being added to the file system image are required to be stageded in one or more stage files /// before burning. Otherwise, VARIANT_FALSE is returned if IMAPI is permitted to optimize the image creation process by /// not staging the files being added to the file system image. /// /// /// /// "Staging" is a process in which an image is created on the hard-drive, containing all files to be burned, prior to the /// initiation of the burn operation. /// /// /// Setting this this property to VARIANT_TRUE via IFileSystemImage::put_StageFiles will only affect files that are added /// after the property is set: those files will always be staged. Files that were not staged prior to a specified property value /// of VARIANT_TRUE, will not be staged. /// /// By specifying VARIANT_FALSE, the file system image creation process is optimized in two ways: /// /// /// Less time is required for image generation /// /// /// Less space is consumed on a local disk by IMAPI /// /// /// /// However, in order to avoid buffer underrun problems during burning, a certain minimum throughput is required for read /// operations on non-staged files. In the event that file accessibility or throughput may not meet the requirements of the /// burner, IMAPI enforces file staging regardless of the specified property value. For example, file staging is enforced for /// source files from removable storage devices, such as USB Flash Disk. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_stagefiles HRESULT // get_StageFiles( VARIANT_BOOL *pVal ); [DispId(30)] bool StageFiles { [return: MarshalAs(UnmanagedType.VariantBool)] get; set; } ///

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

/// /// List of multi-session interfaces for the optical media. Each element of the list is a VARIANT of type /// VT_Dispatch. Query the pdispVal member of the variant for the IMultisession interface. /// /// /// Query the IMultisession interface for a derived IMultisession interface, for example, the IMultisessionSequential interface. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_multisessioninterfaces HRESULT // get_MultisessionInterfaces( SAFEARRAY **pVal ); [DispId(40)] IMultisession[] MultisessionInterfaces { [return: MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(SafeArrayMarshaler))] get; set; } } ///

/// Use this interface to write multiple boot entries or boot images required for the EFI/UEFI support. For example, boot media with /// boot straps for both Windows XP and Windows Vista. ///

/// /// /// Boot entries are limited by the interface to 32 per disc. The boot image must be supplied to IMAPIv2FS by outside applications /// who invoke IMAPIv2FS to build the bootable disc. /// /// Section Entry Extension is not supported by IMAPIv2FS at this time. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nn-imapi2fs-ifilesystemimage2 [PInvokeData("imapi2fs.h", MSDNShortId = "NN:imapi2fs.IFileSystemImage2")] [ComImport, Guid("D7644B2C-1537-4767-B62F-F1387B02DDFD"), InterfaceType(ComInterfaceType.InterfaceIsDual), CoClass(typeof(MsftFileSystemImage))] public interface IFileSystemImage2 : IFileSystemImage { ///

Retrieves the root directory item.

/// An IFsiDirectoryItem interface of the root directory item. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_root HRESULT get_Root( // IFsiDirectoryItem **pVal ); [DispId(0)] new IFsiDirectoryItem Root { [return: MarshalAs(UnmanagedType.Interface)] get; } ///

Retrieves the starting block address for the recording session.

Retrieves the maximum number of blocks available for the image.

Set maximum number of blocks available based on the capabilities of the recorder.

/// /// An IDiscRecorder2 interface that identifies the recording device from which you want to set the maximum number of blocks available. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-setmaxmediablocksfromdevice HRESULT // SetMaxMediaBlocksFromDevice( IDiscRecorder2 *discRecorder ); [DispId(36)] new void SetMaxMediaBlocksFromDevice(IDiscRecorder2 discRecorder); ///

Retrieves the number of blocks in use.

Retrieves or sets the volume name for this file system image.

/// String that contains the volume name for this file system image. /// To set the volume name, call the IFileSystemImage::put_VolumeName method. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_volumename HRESULT // get_VolumeName( BSTR *pVal ); [DispId(4)] new string VolumeName { [return: MarshalAs(UnmanagedType.BStr)] get; set; } ///

Retrieves the volume name provided from an imported file system.

/// /// String that contains the volume name provided from an imported file system. Is NULL until a file system is imported. /// /// /// The imported volume name is provided for user information and is not automatically carried forward to subsequent sessions. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_importedvolumename HRESULT // get_ImportedVolumeName( BSTR *pVal ); [DispId(5)] new string ImportedVolumeName { [return: MarshalAs(UnmanagedType.BStr)] get; } ///

Retrieves the boot image that you want to add to the file system image.

/// An IBootOptions interface of the boot image to add to the disc. Is NULL if a boot image has not been specified. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_bootimageoptions HRESULT // get_BootImageOptions( IBootOptions **pVal ); [DispId(6)] new IBootOptions BootImageOptions { [return: MarshalAs(UnmanagedType.Interface)] get; set; } ///

Retrieves the number of files in the file system image.

Retrieves the number of directories in the file system image.

Retrieves the temporary directory in which stash files are built.

/// String that contains the path to the temporary directory. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_workingdirectory HRESULT // get_WorkingDirectory( BSTR *pVal ); [DispId(9)] new string WorkingDirectory { [return: MarshalAs(UnmanagedType.BStr)] get; set; } ///

Retrieves the change point identifier.

Determines the compliance level for creating and developing the file-system image.

/// /// Is VARIANT_TRUE if the file system images are created in strict compliance with applicable standards. /// Is VARIANT_FALSE if the compliance standards are relaxed to be compatible with IMAPI version 1.0. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_strictfilesystemcompliance // HRESULT get_StrictFileSystemCompliance( VARIANT_BOOL *pVal ); [DispId(11)] new bool StrictFileSystemCompliance { [return: MarshalAs(UnmanagedType.VariantBool)] get; set; } ///

Determines if the file and directory names use a restricted character.

/// /// Is VARIANT_TRUE if the file and directory names to add to the file system image must consist of characters that map directly /// to CP_ANSI (code points 32 through 127). Otherwise, VARIANT_FALSE. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_userestrictedcharacterset // HRESULT get_UseRestrictedCharacterSet( VARIANT_BOOL *pVal ); [DispId(12)] new bool UseRestrictedCharacterSet { [return: MarshalAs(UnmanagedType.VariantBool)] get; set; } ///

Retrieves the types of file systems to create when generating the result stream.

/// /// One or more file system types to create when generating the result stream. For possible values, see the FsiFileSystems /// enumeration type. /// /// /// /// To specify the file system types, call the IFileSystemImage::put_FileSystemsToCreate method. You could also call either /// IFilesystemImage::ChooseImageDefaults or IFilesystemImage::ChooseImageDefaultsForMediaType to have IMAPI choose the file /// system for you. /// /// To retrieve a list of supported file system types, call the IFileSystemImage::get_FileSystemsSupported method. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_filesystemstocreate HRESULT // get_FileSystemsToCreate( FsiFileSystems *pVal ); [DispId(13)] new FsiFileSystems FileSystemsToCreate { get; set; } ///

Retrieves the list of file system types that a client can use to build a file system image.

Retrieves the UDF revision level of the imported file system image.

Retrieves a list of supported UDF revision levels.

/// /// List of supported UDF revision levels. Each element of the list is VARIANT. The variant type is VT_I4. The /// lVal member of the variant contains the revision level. /// /// /// The value is encoded according to the UDF specification, except the variable size is LONG. For example, revision level 1.02 /// is represented as 0x102. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_udfrevisionssupported HRESULT // get_UDFRevisionsSupported( SAFEARRAY **pVal ); [DispId(31)] new int[] UDFRevisionsSupported { [return: MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(SafeArrayMarshaler))] get; } ///

Sets the default file system types and the image size based on the current media.

/// An IDiscRecorder2 the identifies the device that contains the current media. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-chooseimagedefaults HRESULT // ChooseImageDefaults( IDiscRecorder2 *discRecorder ); [DispId(32)] new void ChooseImageDefaults(IDiscRecorder2 discRecorder); ///

Sets the default file system types and the image size based on the specified media type.

/// /// Identifies the physical media type that will receive the burn image. For possible values, see the IMAPI_MEDIA_PHYSICAL_TYPE /// enumeration type. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-chooseimagedefaultsformediatype // HRESULT ChooseImageDefaultsForMediaType( IMAPI_MEDIA_PHYSICAL_TYPE value ); [DispId(33)] new void ChooseImageDefaultsForMediaType(IMAPI_MEDIA_PHYSICAL_TYPE value); ///

Retrieves the ISO9660 compatibility level to use when creating the result image.

Retrieves the supported ISO9660 compatibility levels.

/// /// List of supported ISO9660 compatibility levels. Each item in the list is a VARIANT that identifies one supported interchange /// level. The variant type is VT_UI4. The ulVal member of the variant contains the compatibility level. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_iso9660interchangelevelssupported // HRESULT get_ISO9660InterchangeLevelsSupported( SAFEARRAY **pVal ); [DispId(38)] new uint[] ISO9660InterchangeLevelsSupported { [return: MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(SafeArrayMarshaler))] get; } ///

Create the result object that contains the file system and file data.

Checks for the existence of a given file or directory.

/// String that contains the fully qualified path of the directory or file to check. /// /// Indicates if the item is a file, a directory, or does not exist. For possible values, see the FsiItemType enumeration type. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-exists HRESULT Exists( BSTR // fullPath, FsiItemType *itemType ); [DispId(16)] new FsiItemType Exists([MarshalAs(UnmanagedType.BStr)] string fullPath); ///

Retrieves a string that identifies a disc and the sessions recorded on the disc.

Retrieves a list of the different types of file systems on the optical media.

/// /// An IDiscRecorder2 interface that identifies the recording device that contains the media. If this parameter is NULL, /// the discRecorder specified in IMultisession will be used. /// /// One or more files systems on the disc. For possible values, see FsiFileSystems enumeration type. /// /// Client applications can call IFileSystemImage::GetDefaultFileSystemForImport with the value returned by this method to /// determine the type of file system to import. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-identifyfilesystemsondisc HRESULT // IdentifyFileSystemsOnDisc( IDiscRecorder2 *discRecorder, FsiFileSystems *fileSystems ); [DispId(19)] new FsiFileSystems IdentifyFileSystemsOnDisc(IDiscRecorder2 discRecorder); ///

Retrieves the file system to import by default.

/// One or more file system values. For possible values, see the FsiFileSystems enumeration type. /// /// A single file system value that identifies the default file system. The value is one of the file systems specified in fileSystems /// /// /// Use this method to identify the default file system to use with IFileSystemImage::ImportFileSystem. /// To identify the supported file systems, call the IFileSystemImage::get_FileSystemsSupported method. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-getdefaultfilesystemforimport // HRESULT GetDefaultFileSystemForImport( FsiFileSystems fileSystems, FsiFileSystems *importDefault ); [DispId(20)] new FsiFileSystems GetDefaultFileSystemForImport(FsiFileSystems fileSystems); ///

Imports the default file system on the current disc.

Import a specific file system from disc.

/// /// Identifies the file system to import. For possible values, see the FsiFileSystems enumeration type. /// /// /// /// You must call IFileSystemImage::put_MultisessionInterfaces prior to calling /// IFileSystemImage::ImportSpecificFileSystem. Additionally, it is recommended that /// IDiscFormat2::get_MediaHeuristicallyBlank is called before IFileSystemImage::put_MultisessionInterfaces to verify /// that the media is not blank. /// /// /// 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. /// /// /// On re-writable media (DVD+/-RW, DVDRAM, BD-RE), import or burning a second session is not support if the first session has /// an ISO9660 file system, due to file system limitations. /// /// /// 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_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 documention. If the file system specified by fileSystemToUse has /// not been found, this method returns IMAPI_E_FILE_SYSTEM_NOT_FOUND. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-importspecificfilesystem HRESULT // ImportSpecificFileSystem( FsiFileSystems fileSystemToUse ); [DispId(22)] new void ImportSpecificFileSystem(FsiFileSystems fileSystemToUse); ///

Reverts the image back to the specified change point.

Locks the file system information at the current change-point level.

Create a directory item with the specified name.

/// String that contains the name of the directory item to create. /// /// An IFsiDirectoryItem interface of the new directory item. When done, call the IFsiDirectoryItem::Release method to /// release the interface. /// /// /// After setting properties on the IFsiDirectoryItem interface, call the IFsiDirectoryItem::Add method on the parent directory /// item to add it to the file system image. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-createdirectoryitem HRESULT // CreateDirectoryItem( BSTR name, IFsiDirectoryItem **newItem ); [DispId(25)] new IFsiDirectoryItem CreateDirectoryItem([MarshalAs(UnmanagedType.BStr)] string name); ///

Create a file item with the specified name.

/// String that contains the name of the file item to create. /// /// An IFsiFileItem interface of the new file item. When done, call the IFsiFileItem::Release method to release the interface. /// /// /// After setting properties on the IFsiFileItem interface, call the IFsiDirectoryItem::Add method on the parent directory item /// to add it to the file system image. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-createfileitem HRESULT // CreateFileItem( BSTR name, IFsiFileItem **newItem ); [DispId(26)] new IFsiFileItem CreateFileItem([MarshalAs(UnmanagedType.BStr)] string name); ///

Retrieves the volume name for the UDF system image.

/// String that contains the volume name for the UDF system image. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_volumenameudf HRESULT // get_VolumeNameUDF( BSTR *pVal ); [DispId(27)] new string VolumeNameUDF { [return: MarshalAs(UnmanagedType.BStr)] get; } ///

Retrieves the volume name for the Joliet system image.

/// String that contains the volume name for the Joliet system image. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_volumenamejoliet HRESULT // get_VolumeNameJoliet( BSTR *pVal ); [DispId(28)] new string VolumeNameJoliet { [return: MarshalAs(UnmanagedType.BStr)] get; } ///

Retrieves the volume name for the ISO9660 system image.

/// String that contains the volume name for the ISO9660 system image. // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_volumenameiso9660 HRESULT // get_VolumeNameISO9660( BSTR *pVal ); [DispId(29)] new string VolumeNameISO9660 { [return: MarshalAs(UnmanagedType.BStr)] get; } ///

Indicates if the files being added to the file system image should be staged before the burn.

/// /// VARIANT_TRUE if the files being added to the file system image are required to be stageded in one or more stage files /// before burning. Otherwise, VARIANT_FALSE is returned if IMAPI is permitted to optimize the image creation process by /// not staging the files being added to the file system image. /// /// /// /// "Staging" is a process in which an image is created on the hard-drive, containing all files to be burned, prior to the /// initiation of the burn operation. /// /// /// Setting this this property to VARIANT_TRUE via IFileSystemImage::put_StageFiles will only affect files that are added /// after the property is set: those files will always be staged. Files that were not staged prior to a specified property value /// of VARIANT_TRUE, will not be staged. /// /// By specifying VARIANT_FALSE, the file system image creation process is optimized in two ways: /// /// /// Less time is required for image generation /// /// /// Less space is consumed on a local disk by IMAPI /// /// /// /// However, in order to avoid buffer underrun problems during burning, a certain minimum throughput is required for read /// operations on non-staged files. In the event that file accessibility or throughput may not meet the requirements of the /// burner, IMAPI enforces file staging regardless of the specified property value. For example, file staging is enforced for /// source files from removable storage devices, such as USB Flash Disk. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_stagefiles HRESULT // get_StageFiles( VARIANT_BOOL *pVal ); [DispId(30)] new bool StageFiles { [return: MarshalAs(UnmanagedType.VariantBool)] get; set; } ///

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

/// /// List of multi-session interfaces for the optical media. Each element of the list is a VARIANT of type /// VT_Dispatch. Query the pdispVal member of the variant for the IMultisession interface. /// /// /// Query the IMultisession interface for a derived IMultisession interface, for example, the IMultisessionSequential interface. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage-get_multisessioninterfaces HRESULT // get_MultisessionInterfaces( SAFEARRAY **pVal ); [DispId(40)] new IMultisession[] MultisessionInterfaces { [return: MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(SafeArrayMarshaler))] get; set; } ///

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

/// /// 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. /// /// /// The SAFEARRAY will be a one-dimensional array. If a boot image is not specified, a zero-sized array will be returned. /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nf-imapi2fs-ifilesystemimage2-get_bootimageoptionsarray HRESULT // get_BootImageOptionsArray( SAFEARRAY **pVal ); [DispId(60)] IBootOptions[] BootImageOptionsArray { [return: MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(SafeArrayMarshaler))] get; set; } } ///

/// Use this interface to set or check the metadata and metadata mirror files in a UDF file system (rev 2.50 and later) to determine redundancy. ///

/// /// /// If the metadata and metadata mirror files are set for redundancy, IMAPI creates identical copies of each in the file system /// image, which results in increased level of fault tolerance. In a scenario where the metadata files are not set for redundancy, /// IMAPI only creates a single copy in the file system image, which can save several MB of space on the burned disc. /// /// The metadata redundancy option is set to TRUE by default. /// IFileSystemImage3 is the default interface of MsftFileSystemImage3 objects. /// /// This interface is supported in Windows Server 2003 with Service Pack 1 (SP1), Windows XP with Service Pack 2 (SP2), and Windows /// Vista via the Windows Feature Pack for Storage. All features provided by this update package are supported natively in Windows 7 /// and Windows Server 2008 R2. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/imapi2fs/nn-imapi2fs-ifilesystemimage3 [PInvokeData("imapi2fs.h", MSDNShortId = "NN:imapi2fs.IFileSystemImage3")] [ComImport, Guid("7CFF842C-7E97-4807-8304-910DD8F7C051"), InterfaceType(ComInterfaceType.InterfaceIsDual), CoClass(typeof(MsftFileSystemImage))] public interface IFileSystemImage3 : IFileSystemImage2 { ///