IInkLineInfo::GetInkExtent method (msinkaut.h)
Specifies the display properties to set on the text ink object (tInk), and retrieves the width of the text ink object in HIMETRIC units.
Syntax
HRESULT GetInkExtent(
[in] INKMETRIC *pim,
[out] UINT *pnWidth
);
Parameters
[in] pim
A pointer to an INKMETRIC structure, which contains the display properties to set on the text ink object, or NULL.
[out] pnWidth
The width of the text ink object in HIMETRIC units.
Return value
This method can return one of these values.
| Return code | Description |
|---|---|
|
Success. |
|
The pnWidth parameter is NULL. |
|
Could not complete the operation. The display properties are not changed. |
Remarks
If the pim parameter is NULL, then the display properties are not changed and the existing properties are used to calculate the extent of the text ink object; otherwise, the display properties are updated, and the extent is calculated from the new properties.
If the IMF_FONT_SELECTED_IN_HDC flag is set in the pim parameter, then the properties of the device context are applied to the ink; otherwise, the INKMETRIC settings of the text ink object are applied.
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 |