IFullScreenVideoEx::GetCaption method (amvideo.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 GetCaption method retrieves the caption associated with the full-screen window.

Syntax

HRESULT GetCaption(
  [out] BSTR *pstrCaption
);

Parameters

[out] pstrCaption

Pointer to a BSTR that receives the caption.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
E_OUTOFMEMORY	Insufficient memory
E_POINTER	NULL pointer argument
S_OK	Success

Remarks

The caption is visible when the window is minimized.

The caller must release the returned string, 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	amvideo.h (include Dshow.h)
Library	Strmiids.lib

Share via