Skip to content

Latest commit

 

History

History
97 lines (77 loc) · 4.01 KB

nf-ocidl-ioleinplacesitewindowless-setfocus.md

File metadata and controls

97 lines (77 loc) · 4.01 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:ocidl.IOleInPlaceSiteWindowless.SetFocus
IOleInPlaceSiteWindowless::SetFocus (ocidl.h)
Sets the keyboard focus for a UI-active, windowless object.
IOleInPlaceSiteWindowless interface [COM]
SetFocus method
IOleInPlaceSiteWindowless.SetFocus
IOleInPlaceSiteWindowless::SetFocus
SetFocus
SetFocus method [COM]
SetFocus method [COM]
IOleInPlaceSiteWindowless interface
_ole_ioleinplacesitewindowless_setfocus
com.ioleinplacesitewindowless_setfocus
ocidl/IOleInPlaceSiteWindowless::SetFocus
com\ioleinplacesitewindowless_setfocus.htm
com
1ea9bade-5e41-49a0-a770-3a5cfc56d0f6
12/05/2018
IOleInPlaceSiteWindowless interface [COM],SetFocus method, IOleInPlaceSiteWindowless.SetFocus, IOleInPlaceSiteWindowless::SetFocus, SetFocus, SetFocus method [COM], SetFocus method [COM],IOleInPlaceSiteWindowless interface, _ole_ioleinplacesitewindowless_setfocus, com.ioleinplacesitewindowless_setfocus, ocidl/IOleInPlaceSiteWindowless::SetFocus
ocidl.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
OCIdl.idl
Windows
19H1
IOleInPlaceSiteWindowless::SetFocus
ocidl/IOleInPlaceSiteWindowless::SetFocus
c++
APIRef
kbSyntax
COM
OCIdl.h
IOleInPlaceSiteWindowless.SetFocus

IOleInPlaceSiteWindowless::SetFocus

-description

Sets the keyboard focus for a UI-active, windowless object.

-parameters

-param fFocus [in]

If TRUE, sets the keyboard focus to the calling object. If FALSE, removes the keyboard focus from the calling object, provided that the object has the focus.

-returns

This method returns S_OK if the keyboard focus was successfully given to the object. If this method is called to release the focus, it should never fail. Other possible return values include the following.

Return code Description
S_FALSE
Keyboard focus was denied to the object.

-remarks

A windowless object calls this method whenever a windowed object would call the SetFocus function. Through this call, the windowless object obtains the keyboard focus and can respond to window messages. Normally, this call is made during the UI activation process and within the notification methods IOleInPlaceActiveObject::OnDocWindowActivate with TRUE and IOleInPlaceActiveObject::OnFrameWindowActivate with TRUE.

In response to this call, the container sets the Windows focus to the window being used to get keyboard messages (usually the container window) and redirects any subsequent keyboard messages to the windowless object that requested the focus.

A windowless object also calls the IOleInPlaceSiteWindowless::SetFocus method with the fFocus parameter set to FALSE to release the keyboard focus without assigning it to any other object. In this case, the container must call the SetFocus function with a NULL parameter so that no window has the focus.

-see-also

IOleInPlaceActiveObject

IOleInPlaceSiteWindowless