CBaseControlWindow.IsCursorHidden 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 IsCursorHidden method retrieves the current state of the m_bCursorHidden data member.

Syntax

HRESULT IsCursorHidden(
   long *CursorHidden
);

Parameters

CursorHidden

Pointer to the value of m_bCursorHidden.

Return value

When called without a parameter, returns OATRUE if the cursor is hidden, or OAFALSE if the cursor is visible.

Remarks

Internal objects should call this member function without the CursorHidden parameter to avoid locking the critical section. External objects access this member function with the CursorHidden parameter through the IVideoWindow::IsCursorHidden method.

Requirements

Requirement Value
Header
Ctlutil.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CBaseControlWindow Class