IDWriteFont::GetInformationalStrings method
Gets a localized strings collection containing the specified informational strings, indexed by locale name.
Syntax
virtual HRESULT GetInformationalStrings(
DWRITE_INFORMATIONAL_STRING_ID informationalStringID,
[out] IDWriteLocalizedStrings **informationalStrings,
[out] BOOL * exists
) = 0;
Parameters
- informationalStringID
-
Type: DWRITE_INFORMATIONAL_STRING_ID
A value that identifies the informational string to get. For example, DWRITE_INFORMATIONAL_STRING_DESCRIPTION specifies a string that contains a description of the font.
- informationalStrings [out]
-
Type: IDWriteLocalizedStrings**
When this method returns, contains an address of a pointer to the newly created localized strings object.
- exists [out]
-
Type: BOOL*
When this method returns, TRUE if the font contains the specified string ID; otherwise, FALSE.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
If the font does not contain the string specified by informationalStringID, the return value is S_OK but informationalStrings receives a NULL pointer and exists receives the value FALSE.
Requirements
|
Minimum supported client |
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps] |
|
Minimum supported phone |
Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also