IMAPI Return Values
The IMAPI methods return non-negative values, (typically S_OK) if the method was successful. The IMAPI methods return success or error codes from Winerror.h, Imapi2error.h, or Imapi2fserror.h, on failure.
The following success and error codes are defined.
| Constant/value | Description |
|---|---|
|
The disc did not pass burn verification and may contain corrupt data or be unusable. |
|
The request was canceled. |
|
The request requires a current disc recorder to be selected. |
|
No write operation is currently in progress. |
|
The requested write speed was not supported by the drive and the speed was adjusted. |
|
The requested rotation type was not supported by the drive and the rotation type was adjusted. |
|
The requested write speed and rotation type were not supported by the drive and they were both adjusted. |
|
The device accepted the command, but returned sense data, indicating an error. |
|
The image has become read-only due to a call to IRawCDImageCreator::CreateResultImage. As a result the object can no longer be modified. |
|
No more tracks may be added. CD media is restricted to a range of 1-99 tracks. |
|
Tracks must be added to the image before using this function. |
|
The requested sector type is not supported. |
|
Tracks may not be added to the image prior to the use of this function. |
|
Adding this track would exceed the limitations of the start of the leadout. |
|
Adding this track would exceed the 99 index limit. |
|
The specified LBA offset is not in the list of track indexes. |
|
The specified LBA offset is already in the list of track indexes. |
|
Index 1 (LBA offset zero) cannot be cleared. |
|
Each index must have a minimum size of ten sectors. |
|
The device reported that the requested mode page (and type) is not present. |
|
There is no media in the device. |
|
The media is not compatible or of unknown physical format. |
|
The media is inserted upside down. |
|
The drive reported that it is in the process of becoming ready. Please try the request again later. |
|
The media is currently being formatted. Please wait for the format to complete before attempting to use the media. |
|
The drive reported that it is performing a long-running operation, such as finishing a write. The drive may be unusable for a long period of time. |
|
The drive reported that the combination of parameters provided in the mode page for a MODE SELECT command were not supported. |
|
The drive reported that the media is write protected. |
|
The feature page requested is not supported by the device. |
|
The feature page requested is supported, but is not marked as current. |
|
The drive does not support the GET CONFIGURATION command. |
|
The device failed to accept the command within the timeout period. This may be caused by the device having entered an inconsistent state, or the timeout value for the command may need to be increased. |
|
The DVD structure is not present. This may be caused by incompatible drive/medium used. |
|
The media's speed is incompatible with the device. This may be caused by using higher or lower speed media than the range of speeds supported by the device. |
|
The device associated with this recorder during the last operation has been exclusively locked, causing this operation to fail. |
|
The client name is not valid. |
|
The device reported unexpected or invalid data for a command. |
|
The write failed because the drive did not receive data quickly enough to continue writing. Moving the source data to the local computer, reducing the write speed, or enabling a "buffer underrun free" setting may resolve this issue. |
|
The write failed because the drive returned error information that could not be recovered from. |
|
There is currently a write operation in progress. |
|
There is no write operation currently in progress. |
|
The requested operation is only valid with supported media. |
|
The provided stream to write is not supported. |
|
The provided stream to write is too large for the currently inserted media. |
|
Overwriting non-blank media is not allowed without the ForceOverwrite property set to VARIANT_TRUE. |
|
The current media type is unsupported. |
|
This device does not support the operations required by this disc format. |
|
The client name is not valid. |
|
There is currently a write operation in progress. |
|
There is no write operation currently in progress. |
|
The requested operation is only valid when media has been "prepared". |
|
The requested operation is not valid when media has been "prepared" but not released. |
|
The property cannot be changed once the media has been written to. |
|
The table of contents cannot be retrieved from an empty disc. |
|
Only blank CD-R/RW media is supported. |
|
Only blank CD-R/RW media is supported. |
|
CD-R and CD-RW media support a maximum of 99 audio tracks. |
|
There is not enough space left on the media to add the provided audio track. |
|
You cannot prepare the media until you choose a recorder to use. |
|
The ISRC provided is not valid. |
|
The Media Catalog Number provided is not valid. |
|
The provided audio stream is not valid. |
|
This device does not support the operations required by this disc format. |
|
The client name is not valid. |
|
There is currently a write operation in progress. |
|
There is no write operation currently in progress. |
|
The requested operation is only valid when media has been "prepared". |
|
The requested operation is not valid when media has been "prepared" but not released. |
|
The client name is not valid. |
|
Only blank CD-R/RW media is supported. |
|
Only blank CD-R/RW media is supported. |
|
There is not enough space on the media to add the provided session. |
|
You cannot prepare the media until you choose a recorder to use. |
|
The provided audio stream is not valid. |
|
The requested data block type is not supported by the current device. |
|
The stream does not contain a sufficient number of sectors in the leadin for the current media. |
|
This device does not support the operations required by this disc format. |
|
The format is currently using the disc recorder for an erase operation. Please wait for the erase to complete before attempting to set or clear the current disc recorder. |
|
The erase format only supports one recorder. You must clear the current recorder before setting a new one. |
|
The drive did not report sufficient data for a READ DISC INFORMATION command. The drive may not be supported, or the media may not be correct. |
|
The drive did not report sufficient data for a MODE SENSE (page 0x2A) command. The drive may not be supported, or the media may not be correct. |
|
The drive reported that the media is not erasable. |
|
The drive failed the erase command. |
| E_IMAPI_ERASE_TOOK_LONGER_THAN_ONE_HOUR (HRESULT)0x80AA0906 |
The drive did not complete the erase in one hour. The drive may require a power cycle, media removal, or other manual intervention to resume proper operation. Note: Currently, this value will also be returned if an attempt to perform an erase on CD-RW or DVD-RW media via the IDiscFormat2Erase interface fails as a result of the media being bad. |
|
The drive returned an unexpected error during the erase. The media may be unusable, the erase may be complete, or the drive may still be in the process of erasing the disc. |
|
The drive returned an error for a START UNIT (spinup) command. Manual intervention may be required. |
|
The current media type is unsupported. |
|
This device does not support the operations required by this disc format. |
|
The client name is not valid. |
The following success and error codes are defined in Imapi2fserror.h.
| Constant/value | Description |
|---|---|
|
Internal error occurred: %1!ls!. |
|
The value specified for parameter '%1!ls!' is not valid. |
|
FileSystemImage object is in read only mode. |
|
No output file system specified. |
|
The specified Volume Identifier is either too long or contains one or more invalid characters. |
|
Invalid file dates. %1!ls! time is earlier than %2!ls! time. |
|
The file system must be empty for this function. |
|
You cannot change the file system specified for creation, because the file system from the imported session and the file system in the current session do not match. |
|
Specified path '%1!ls!' does not identify a file. |
|
Specified path '%1!ls!' does not identify a directory. |
|
The directory '%1!s!' is not empty. |
|
ls!' is not part of the file system. It must be added to complete this operation. |
|
Path '%1!s!' is badly formed or contains invalid characters. |
|
The name '%1!ls!' specified is not legal: Name of file or directory object created while the UseRestrictedCharacterSet property is set may only contain ANSI characters. |
|
ls!' name already exists. |
|
Attempt to add '%1!ls!' failed: cannot create a file-system-specific unique name for the %2!ls! file system. |
|
Cannot find item '%1!ls!' in FileSystemImage hierarchy. |
|
The file '%1!s!' not found in FileSystemImage hierarchy. |
|
The directory '%1!s!' not found in FileSystemImage hierarchy. |
|
Adding '%1!ls!' would result in a result image having a size larger than the current configured limit. |
|
Value specified for FreeMediaBlocks property is too small for estimated image size based on current data. |
|
The image is not aligned on a 2kb sector boundary. |
|
The image does not contain a valid volume descriptor. |
|
The image has not been set using the IIsoImageManager::SetPath or IIsoImageManager::SetStream methods prior to calling the IIsoImageManager::Validate method. |
|
The provided image is too large to be validated as the size exceeds MAXLONG. |
|
Data stream supplied for file '%1!ls!' is inconsistent: expected %2!I64d! bytes, found %3!I64d!. |
|
Cannot read data from stream supplied for file '%1!ls!'. |
|
The following error was encountered when trying to create data stream for file '%1!ls!': |
|
Failure enumerating files in the directory tree is inaccessible due to permissions. |
|
This file system image has too many directories for the %1!ls! file system. |
|
ISO9660 is limited to 8 levels of directories. |
|
Data file is too large for '%1!ls!' file system. |
|
Cannot initialize %1!ls! stash file. |
|
Error seeking in '%1!ls!' stash file. |
|
Error encountered writing to '%1!ls!' stash file. |
|
Error encountered reading from '%1!ls!' stash file. |
|
The working directory '%1!ls!' is not valid. |
|
Cannot set working directory to '%1!ls!'. Space available is %2!I64d! bytes, approximately %3!I64d! bytes required. |
|
Attempt to move the data stash file to directory '%1!ls!' was not successful. |
|
The boot object could not be added to the image. |
|
A boot object can only be included in an initial disc image. |
|
The emulation type requested does not match the boot image size. |
|
Optical media is empty. |
|
The specified disc does not contain one of the supported file systems. |
|
The specified disc does not contain a '%1!ls!' file system. |
|
Consistency error encountered while importing the '%1!ls!' file system. |
|
The '%1!ls!'file system on the selected disc contains a feature not supported for import: %2!ls!. |
|
Could not import %2!ls! file system from disc. The file '%1!ls!' already exists within the image hierarchy as a directory. |
|
Cannot seek to block %1!I64d! on source disc. |
|
Import from previous session failed due to an error reading a block on the media (most likely block %1!u!). |
|
Current disc is not the same one from which file system was imported. |
|
IMAPI does not allow multi-session with the current media type. |
|
IMAPI cannot do multi-session with the current media because it does not support a compatible UDF revision for write. |
|
IMAPI does not support the multisession type requested. |
|
Operation failed due to an incompatible layout of the previous session imported from the medium. |
| IMAPI_E_NO_COMPATIBLE_MULTISESSION_TYPE (HRESULT)0xC0AAB15C |
IMAPI supports none of the multisession type(s) provided on the current media. Note: IFileSystemImage::ImportFileSystem method returns this error if there is no media in the recording device. |
|
MultisessionInterfaces property must be set prior calling this method. |
|
Could not import %2!ls! file system from disc. The directory '%1!ls!' already exists within the image hierarchy as a file. |
|
One of multisession parameters cannot be retrieved or has a wrong value. |
|
This feature is not supported for the current file system revision. The image will be created without this feature. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows XP [desktop apps only] |
| Minimum supported server |
Windows Server 2003 [desktop apps only] |
| Header |
|
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