IDWriteFontFamily::GetFirstMatchingFont method (dwrite.h)

Gets the font that best matches the specified properties.

Syntax

HRESULT GetFirstMatchingFont(
        DWRITE_FONT_WEIGHT  weight,
        DWRITE_FONT_STRETCH stretch,
        DWRITE_FONT_STYLE   style,
  [out] IDWriteFont         **matchingFont
);

Parameters

weight

Type: DWRITE_FONT_WEIGHT

A value that is used to match a requested font weight.

stretch

Type: DWRITE_FONT_STRETCH

A value that is used to match a requested font stretch.

style

Type: DWRITE_FONT_STYLE

A value that is used to match a requested font style.

[out] matchingFont

Type: IDWriteFont**

When this method returns, contains the address of a pointer to the newly created IDWriteFont object.

Return value

Type: HRESULT

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

Requirements

Requirement Value
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

IDWriteFontFamily