IOleInPlaceSiteWindowless.SetCapture(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.OLE.Interop

Assembly:: Microsoft.VisualStudio.OLE.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Enables an in-place active, windowless object to capture all mouse messages.

public:
 int SetCapture(int fCapture);

public:
 int SetCapture(int fCapture);

int SetCapture(int fCapture);

public int SetCapture (int fCapture);

abstract member SetCapture : int -> int

Public Function SetCapture (fCapture As Integer) As Integer

Parameters

fCapture: Int32

[in] If TRUE, the container should capture the mouse for the object. If FALSE, the container should release mouse capture for the object.

Returns

Int32

S_OK Mouse capture was successfully granted to the object. If called to release the mouse capture, this method must not fail. S_FALSE Mouse capture was denied to the object.

Remarks

For information on the COM interface, see IOleInPlaceSiteWindowless::SetCapture

Applies to