IInkLineInfo::SetFormat method (msinkaut.h)

Article
02/22/2024

Specifies the display properties to set on the text ink object (tInk).

Syntax

HRESULT SetFormat(
  [in] INKMETRIC *pim
);

Parameters

[in] pim

A pointer to an INKMETRIC structure which contains the display properties to set on the text ink object.

Return value

This method can return one of these values.

Return code	Description
S_OK	The method succeeded.
E_POINTER	The pim parameter is NULL.
E_OUTOFMEMORY	Could not complete the operation. The display properties are not changed.

Remarks

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

Share via