Edit

Share via

IDiscFormat2::IsCurrentMediaSupported method (imapi2.h)

  • Article

Determines if the current media in a supported recorder supports the given format.

Syntax

HRESULT IsCurrentMediaSupported(
  [in]  IDiscRecorder2 *recorder,
  [out] VARIANT_BOOL   *value
);

Parameters

[in] recorder

An IDiscRecorder2 interface of the recorder to test.

[out] value

Is VARIANT_TRUE if the media in the recorder supports the given format; otherwise, VARIANT_FALSE.

Note  VARIANT_TRUE also implies that the result from IsDiscRecorderSupported is VARIANT_TRUE.
 

Return value

S_OK or S_FALSE are 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_IMAPI_RECORDER_MEDIA_NO_MEDIA
 There is no media in the device.

(HRESULT)0xC0AA0202
 
Note  Currently, Windows Vista will return S_OK and VARIANT_FALSE when media is not present in the device, while E_IMAPI_RECORDER_MEDIA_NO_MEDIA and VARIANT_FALSE are returned in Windows 7.
 

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

IDiscFormat2

IDiscFormat2::IsDiscRecorderSupported