IVideoWindow::IsCursorHidden 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 IsCursorHidden method queries whether the cursor is hidden.

Syntax

HRESULT IsCursorHidden(
  [out] long *CursorHidden
);

Parameters

[out] CursorHidden

Receives the value OATRUE if the cursor is hidden, or OAFALSE if the cursor is displayed.

Return value

Possible return values include the following:

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

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

See also

Error and Success Codes

IVideoWindow Interface

IVideoWindow::HideCursor