IInkPicture::GetWindowInputRectangle method (msinkaut.h)

Article
10/13/2021

Retrieves the window rectangle, in pixels, within which ink is drawn.

Syntax

HRESULT GetWindowInputRectangle(
  [out] IInkRectangle **WindowInputRectangle
);

Parameters

[out] WindowInputRectangle

Gets the rectangle, of type InkRectangle, on which ink is drawn.

Return value

This method can return one of these values.

Return code	Description
S_OK	Success.
E_POINTER	A parameter contains an invalid pointer.
REGDB_CLASSNOTREG	The InkRectangle object is not registered.
E_INK_EXCEPTION	An exception occurs inside the method.

Remarks

You must first allocate the rectangle before passing it on to this method.

By default, the window input rectangle is set to {0,0,0,0}. This default rectangle maps to the size of the entire window.

If you call GetWindowInputRectangle before you call the SetWindowInputRectangle method, this method gets a rectangle with the default coordinates.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	msinkaut.h
Library	InkObj.dll