IDWriteFontFace3::GetInformationalStrings method

Gets a localized strings collection that contains the specified informational strings, indexed by locale name.

Syntax

HRESULT GetInformationalStrings(
  [in]  DWRITE_INFORMATIONAL_STRING_ID informationalStringID,
  [out] IDWriteLocalizedStrings        **informationalStrings,
  [out] BOOL                           *exists
);

Parameters

informationalStringID [in]

Type: DWRITE_INFORMATIONAL_STRING_ID

A DWRITE_INFORMATIONAL_STRING_ID-typed value that identifies the strings to get.

informationalStrings [out]

Type: IDWriteLocalizedStrings**

A pointer to a memory block that receives a pointer to a IDWriteLocalizedStrings interface for the newly created localized strings object.

exists [out]

Type: BOOL*

A pointer to a variable that receives whether the font contains the specified string ID. TRUE if the font contains the specified string ID; otherwise, FALSE.

Return value

Type: HRESULT

If the font doesn't contain the specified string, the return value is S_OK, but informationalStrings receives a NULL pointer and exists receives the value FALSE.

Requirements

See also

IDWriteFontFace3