IDiscFormat2Data interface (imapi2.h)
Use this interface to write a data stream to a disc.
To create an instance of this interface, call the CoCreateInstance function. Use__uuidof(MsftDiscFormat2Data) for the class identifier and __uuidof(IDiscFormat2Data) for the interface identifier.
Inheritance
The IDiscFormat2Data interface inherits from IDiscFormat2. IDiscFormat2Data also has these types of members:
Methods
The IDiscFormat2Data interface has these methods.
| IDiscFormat2Data::CancelWrite Cancels the current write operation. (IDiscFormat2Data.CancelWrite) |
| IDiscFormat2Data::get_BufferUnderrunFreeDisabled Determines if Buffer Underrun Free recording is enabled for CDR, CD-RW, and DVD-R media. |
| IDiscFormat2Data::get_ClientName Retrieves the friendly name of the client. (IDiscFormat2Data.get_ClientName) |
| IDiscFormat2Data::get_CurrentMediaStatus Retrieves the current state of the media in the device. |
| IDiscFormat2Data::get_CurrentPhysicalMediaType Retrieves the type of media in the disc device. (IDiscFormat2Data.get_CurrentPhysicalMediaType) |
| IDiscFormat2Data::get_CurrentRotationTypeIsPureCAV Retrieves the current rotational-speed control used by the recorder. (IDiscFormat2Data.get_CurrentRotationTypeIsPureCAV) |
| IDiscFormat2Data::get_CurrentWriteSpeed Retrieves the drive's current write speed. (IDiscFormat2Data.get_CurrentWriteSpeed) |
| IDiscFormat2Data::get_DisableConsumerDvdCompatibilityMode Determines if a DVD recording session includes tasks that can increase the chance that a device can play the DVD. (Get) |
| IDiscFormat2Data::get_ForceMediaToBeClosed Determines if further additions to the file system are prevented. (Get) |
| IDiscFormat2Data::get_ForceOverwrite Determines if the data writer must overwrite the disc on overwritable media types. (Get) |
| IDiscFormat2Data::get_FreeSectorsOnMedia Retrieves the number of free sectors on the disc for incremental recording (without overwriting existing data). |
| IDiscFormat2Data::get_LastWrittenAddressOfPreviousSession Retrieves the last sector of the previous write session. |
| IDiscFormat2Data::get_MultisessionInterfaces Retrieves a list of available multi-session interfaces. |
| IDiscFormat2Data::get_NextWritableAddress Retrieves the location for the next write operation. |
| IDiscFormat2Data::get_PostgapAlreadyInImage Determines if the data stream contains post-writing gaps. (Get) |
| IDiscFormat2Data::get_Recorder Retrieves the recording device to use for the write operation. (IDiscFormat2Data.get_Recorder) |
| IDiscFormat2Data::get_RequestedRotationTypeIsPureCAV Retrieves the requested rotational-speed control type. (IDiscFormat2Data.get_RequestedRotationTypeIsPureCAV) |
| IDiscFormat2Data::get_RequestedWriteSpeed Retrieves the requested write speed. (IDiscFormat2Data.get_RequestedWriteSpeed) |
| IDiscFormat2Data::get_StartAddressOfPreviousSession Retrieves the first sector of the previous write session. |
| IDiscFormat2Data::get_SupportedWriteSpeedDescriptors Retrieves a list of the detailed write configurations supported by the disc recorder and current media. (IDiscFormat2Data.get_SupportedWriteSpeedDescriptors) |
| IDiscFormat2Data::get_SupportedWriteSpeeds Retrieves a list of the write speeds supported by the disc recorder and current media. (IDiscFormat2Data.get_SupportedWriteSpeeds) |
| IDiscFormat2Data::get_TotalSectorsOnMedia Retrieves the number of sectors on the media in the device. |
| IDiscFormat2Data::get_WriteProtectStatus Retrieves the current write protect state of the media in the device. |
| IDiscFormat2Data::put_BufferUnderrunFreeDisabled Determines if Buffer Underrun Free recording is enabled. (IDiscFormat2Data.put_BufferUnderrunFreeDisabled) |
| IDiscFormat2Data::put_ClientName Sets the friendly name of the client. (IDiscFormat2Data.put_ClientName) |
| IDiscFormat2Data::put_DisableConsumerDvdCompatibilityMode Determines if a DVD recording session includes tasks that can increase the chance that a device can play the DVD. (Put) |
| IDiscFormat2Data::put_ForceMediaToBeClosed Determines if further additions to the file system are prevented. (Put) |
| IDiscFormat2Data::put_ForceOverwrite Determines if the data writer must overwrite the disc on overwritable media types. (Put) |
| IDiscFormat2Data::put_PostgapAlreadyInImage Determines if the data stream contains post-writing gaps. (Put) |
| IDiscFormat2Data::put_Recorder Sets the recording device to use for the write operation. (IDiscFormat2Data.put_Recorder) |
| IDiscFormat2Data::SetWriteSpeed Sets the write speed of the disc recorder. (IDiscFormat2Data.SetWriteSpeed) |
| IDiscFormat2Data::Write Writes the data stream to the device. |
Remarks
To create the MsftDiscFormat2Data object in a script, use IMAPI2.MsftDiscFormat2Data as the program identifier when calling CreateObject.
It is possible for a power state transition to take place during a burn operation (i.e. user log-off or system suspend) which leads to the interruption of the burn process and possible data loss. For programming considerations, see Preventing Logoff or Suspend During a Burn.
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 | imapi2.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