IInkOverlay::GetWindowInputRectangle
4/8/2010
Gets the window rectangle, in pixels, within which ink is drawn for the IInkOverlay control.
Syntax
HRESULT GetWindowInputRectangle (
[out] IInkRectangle **windowRectangle
);
Parameters
- windowRectangle
[out] Gets the rectangle, of type IInkRectangle, on which ink is drawn.
Return Value
| HRESULT value | Description |
|---|---|
S_OK |
Success. |
E_POINTER |
A parameter contains an invalid pointer. |
REGDB_CLASSNOTREG |
The IInkRectangle 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 IInkOverlay::SetWindowInputRectangle method, this method gets a rectangle with the default coordinates.
Requirements
| Header | msinkaut.h |
| Windows Embedded CE | Windows CE 5.0 and later |
| Windows Mobile | Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later |