IPrintCoreHelper::SetFontSubstitution method (prcomoem.h)

Article
01/13/2023

The IPrintCoreHelper::SetFontSubstitution method specifies the device font to print in place of a given TrueType font.

Syntax

HRESULT SetFontSubstitution(
  [in] IN PCWSTR pszTrueTypeFontName,
  [in] IN PCWSTR pszDevFontName
);

Parameters

[in] pszTrueTypeFontName

A pointer to a null-terminated Unicode string that contains a valid TrueType font name. This parameter must not be NULL.

[in] pszDevFontName

A pointer to a null-terminated Unicode string that contains the name of the device font.

Return value

IPrintCoreHelper::SetFontSubstitution should return one of the following values:

Return code	Description
S_OK	The method read the option for the specified feature.
E_FAIL	The font that was requested does not exist or was not a TrueType font.
E_INVALIDARG	One or more of the arguments is invalid.
E_OUTOFMEMORY	The core driver was not able to service the request because there was insufficient memory.
E_UNEXPECTED, or other return codes not listed here	The core driver seems to be in an invalid state. The caller should return a failure code.

Remarks

Setting a device font to use in place of a specified TrueType font can occur only during the device property sheets session and only if full UI replacement is enabled. The font that is represented by the pszTrueTypeFontName parameter must be a valid TrueType font and must be installed on the printer. The device font that is represented by the pszDevFontName parameter must be a valid font for this printer.

If a substitution mapping for the specified TrueType font already exists on this queue, the SetFontSubstitution method will silently replace the mapping. To remove a substitution mapping, call this method with the TrueType font name specified in pszTrueTypeFontName and with NULL specified in pszDevFontName.

To obtain a list of valid device fonts, create an information context for the current printer, and call SetGraphicsMode(hIC, GM_ADVANCED). Then, enumerate device fonts by means of a call to EnumFontFamilies. The callback parameter ((see EnumFontFamProc) of EnumFontFamilies should filter for device fonts by incrementing a counter for each font for which the bitwise AND result (FontType & TRUETYPE_FONTTYPE) is nonzero.

Requirements

Requirement	Value
Target Platform	Desktop
Header	prcomoem.h (include Prcomoem.h)