IDiscRecorder2Ex::GetFeaturePage method (imapi2.h)

Retrieves the specified feature page from the device.

Syntax

HRESULT GetFeaturePage(
  [in]  IMAPI_FEATURE_PAGE_TYPE   requestedFeature,
  [in]  BOOLEAN                   currentFeatureOnly,
  [out] BYTE                      **featureData,
  [out] ULONG_IMAPI2_FEATURE_PAGE *byteSize
);

Parameters

[in] requestedFeature

Feature page to retrieve. For possible values, see the IMAPI_FEATURE_PAGE_TYPE enumeration type.

[in] currentFeatureOnly

Set to True to retrieve the feature page only when it is the current feature page. Otherwise, False to retrieve the feature page regardless of it being the current feature page.

[out] featureData

Data buffer that contains the feature page. For details of the contents of the data buffer, see the GET CONFIGURATION command in the latest revision of the MMC specification at ftp://ftp.t10.org/t10/drafts/mmc5.

This method removes header information and other non-feature data before filling and sending this buffer.

When done, call the CoTaskMemFree function to free the memory.

[out] byteSize

Size, in bytes, of the featureData data buffer.

Return value

S_OK is returned on success, but other success codes may be returned as a result of implementation. The following error codes are commonly returned on operation failure, but do not represent the only possible error values:

Return code Description
E_POINTER
Pointer is not valid.

Value: 0x80004003

E_FAIL
Unspecified failure.

Value: 0x80004005

E_IMAPI_RECORDER_GET_CONFIGURATION_NOT_SUPPORTED
The drive does not support the GET CONFIGURATION command.

Value: 0xC0AA020C

E_IMAPI_RECORDER_NO_SUCH_FEATURE
The feature page requested is not supported by the device.

Value: 0xC0AA020A

E_OUTOFMEMORY
Failed to allocate the required memory.

Value: 0x8007000E

E_IMAPI_RECORDER_FEATURE_IS_NOT_CURRENT
The feature page requested is supported, but is not marked as current.

Value: 0xC0AA020B

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

Value: 0xC0AA020D

E_IMAPI_RECORDER_INVALID_RESPONSE_FROM_DEVICE
The device reported unexpected or invalid data for a command.

Value: 0xC0AA02FF

E_IMAPI_RECORDER_MEDIA_UPSIDE_DOWN
The media is inserted upside down.

Value: 0xC0AA0204

E_IMAPI_RECORDER_MEDIA_BECOMING_READY
The drive reported that it is in the process of becoming ready. Please try the request again later.

Value: 0xC0AA0205

E_IMAPI_RECORDER_MEDIA_NO_MEDIA
There is no media in the device.

Value: 0xC0AA0202

E_IMAPI_RECORDER_MEDIA_FORMAT_IN_PROGRESS
The media is currently being formatted. Please wait for the format to complete before attempting to use the media.

Value: 0xC0AA0206

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

Value: 0xC0AA0207

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

Value: 0xC0AA0300

E_IMAPI_RECORDER_MEDIA_INCOMPATIBLE
The media is not compatible or of unknown physical format.

Value: 0xC0AA0203

E_IMAPI_RECORDER_DVD_STRUCTURE_NOT_PRESENT
The DVD structure is not present. This may be caused by incompatible drive/medium used.

Value: 0xC0AA020E

E_IMAPI_RECORDER_NO_SUCH_MODE_PAGE
The device reported that the requested mode page (and type) is not present.

Value: 0xC0AA0201

E_IMAPI_RECORDER_INVALID_MODE_PARAMETERS
The drive reported that the combination of parameters provided in the mode page for a MODE SELECT command were not supported.

Value: 0xC0AA0208

E_IMAPI_RECORDER_MEDIA_WRITE_PROTECTED
The drive reported that the media is write protected.

Value: 0xC0AA0209

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

Value: 0xC0AA020F

HRESULT_FROM_WIN32(ERROR_INVALID_HANDLE)
The specified handle is invalid.

Value: 6

HRESULT_FROM_WIN32(ERROR_DEV_NOT_EXIST)
The specified network resource or device is no longer available.

Value: 55

E_IMAPI_RECORDER_LOCKED
The device associated with this recorder during the last operation has been exclusively locked, causing this operation to failed.

Value: 0xC0AA0210

Requirements

   
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

IDiscRecorder2Ex

IDiscRecorder2Ex::GetSupportedFeaturePages

IMAPI_FEATURE_PAGE_TYPE