IXpsOMGlyphs::GetDeviceFontName method (xpsobjectmodel.h)

Article
02/22/2024

Gets the name of the device font.

Syntax

HRESULT GetDeviceFontName(
  [out, retval] LPWSTR *deviceFontName
);

Parameters

[out, retval] deviceFontName

The string that contains the unescaped name of the device font. If the name has not been set, a NULL pointer will be returned.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code	Description
S_OK	The method succeeded.
E_POINTER	deviceFontName is NULL.

Remarks

The device font name uniquely identifies a specific device font and is typically defined by a hardware vendor or font vendor.

The escaped version of the device font name is created when the object is serialized.

This method allocates the memory used by the string that is returned in deviceFontName. If deviceFontName is not NULL, use the CoTaskMemFree function to free the memory.

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	xpsobjectmodel.h