Edit

IDiscFormat2::IsRecorderSupported method (imapi2.h)

  • Article

Determines if the recorder supports the given format.

Syntax

HRESULT IsRecorderSupported(
  [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 recorder supports the given format; otherwise, VARIANT_FALSE.

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

Remarks

When implemented by the IDiscFormat2RawCD interface, this method will return E_IMAPI_DF2RAW_MEDIA_IS_NOT_SUPPORTED in the event the recorder does not support the given format. It is important to note that in this specific scenario the value does not indicate that an error has occurred, but rather the result of a successful operation.

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