IAMMediaContent::get_Description method (qnetwork.h)

Article
4/26/2023

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The get_Description method retrieves a description of the content.

Syntax

HRESULT get_Description(
  BSTR *pbstrDescription
);

Parameters

pbstrDescription

Pointer to a variable that receives a BSTR with the information.

Return value

Returns an HRESULT value. Possible values include those shown in the following table.

Return code	Description
S_OK	Success.
E_NOTIMPL	Not implemented.
E_OUTOFMEMORY	Insufficient memory.
VFW_E_NOT_FOUND	Item not found.

Remarks

If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	qnetwork.h

Partager via