CBaseControlWindow.get_Caption method
[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_Caption
method retrieves the current window caption.
Syntax
HRESULT get_Caption(
BSTR *pstrCaption
);
Parameters
-
pstrCaption
-
Pointer to the current window caption.
Return value
Returns an HRESULT value.
Remarks
Most top-level windows on a Windows-based desktop have a title (caption) associated with them. This property can be queried and set through the IVideoWindow interface. Any caption set will be visible only if the window has the WS_CAPTION style applied. If it does not, the caption can still be set (and retrieved), although it will not be visible to the user.
Requirements
Requirement | Value |
---|---|
Header |
|
Library |
|