IDWriteGdiInterop::ConvertFontToLOGFONT method

Initializes a LOGFONT structure based on the GDI-compatible properties of the specified font.

Syntax

HRESULT ConvertFontToLOGFONT(
  IDWriteFont *font,
  LOGFONTW    *logFont,
  BOOL        *isSystemFont
);

Parameters

font

Type: IDWriteFont*

An IDWriteFont object to be converted into a GDI-compatible LOGFONT structure.

logFont

Type: LOGFONTW*

When this method returns, contains a structure that receives a GDI-compatible font description.

isSystemFont

Type: BOOL*

When this method returns, contains TRUE if the specified font object is part of the system font collection; otherwise, FALSE.

Return Value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The conversion to a LOGFONT by using ConvertFontToLOGFONT operates at the logical font level and does not guarantee that it will map to a specific physical font. It is not guaranteed that GDI will select the same physical font for displaying text formatted by a LOGFONT as the IDWriteFont object that was converted.

Requirements

   
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header dwrite.h
Library Dwrite.lib
DLL Dwrite.dll

See Also

IDWriteGdiInterop