IVideoWindow::get_Caption method (control.h)
[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 video window caption.
Syntax
HRESULT get_Caption(
[out] BSTR *strCaption
);
Parameters
[out] strCaption
Pointer to a BSTR that receives the caption.
Return value
Possible return values include the following:
| Return code | Description |
|---|---|
|
NULL pointer. |
|
Success. |
|
The video renderer filter is not connected. |
Remarks
The caller must free the returned string, using 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 | control.h (include Dshow.h) |
| Library | Strmiids.lib |