IVideoWindow::get_Caption

  • Article
 
Microsoft DirectShow 9.0

IVideoWindow::get_Caption

The get_Caption method retrieves the video window caption.

Syntax

  HRESULT get_Caption(
    BSTR *strCaption
);

Parameters

strCaption

[out] Pointer to a BSTR that receives the caption.

Return Values

Possible return values include the following:

Value Description
E_POINTER NULL pointer.
S_OK Success.
VFW_E_NOT_CONNECTED The video renderer filter is not connected.

Remarks

The caller must free the returned string, using the SysFreeString function.

Requirements

Header: Declared in Control.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also