IInkLineInfo::GetFormat method (msinkaut.h)

Returns the display properties currently set on the text ink object (tInk).

Syntax

HRESULT GetFormat(
  [out] INKMETRIC *pim
);

Parameters

[out] pim

A pointer to an INKMETRIC structure that stores the display properties of 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.

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

See also

GetInkExtent Method

IInkLineInfo

INKMETRIC Structure

SetFormat Method