SetFormat Method
SetFormat Method |
Specifies the display properties to set on the text ink object (tInk).
Syntax
[C++]
HRESULT SetFormat (
[in] INKMETRIC* pim
);
Parameters
pim
[in] A pointer to an INKMETRIC structure which contains the display properties to set on the text ink object.
Return Value
| HRESULT value | Description |
|---|---|
| S_OK | The method succeeded. |
| E_POINTER | The pim parameter is NULL (Nothing in Microsoft® Visual Basic® 6.0). |
| 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.