Jump to content

GreUnLoadFont

From EDM2
Revision as of 03:08, 2 January 2020 by Martini (talk | contribs) (Created page with "GreUnLoadFont unloads the private font definitions previously loaded from the resource file indicated by pszFilename. This function is supported by the graphics engine. ==...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

GreUnLoadFont unloads the private font definitions previously loaded from the resource file indicated by pszFilename.

This function is supported by the graphics engine.

Syntax

 GreUnLoadFont(pszFilename, pInstance, lFunction);

Parameters

pszFilename (PSZ) - input
Pointer to a NULL-terminated string containing the file path and name of the font file.
pInstance (PVOID) - input
Pointer to instance data.
lFunction (ULONG) - input
High-order WORD=flags; low-order WORD=NGreUnLoadFont.

Return Code

fSuccess (BOOL) - returns
Return codes.
On completion, the handling routine must return BOOLEAN (fSuccess).
  • TRUE Successful
  • FALSE Error
Possible Errors Detected: When an error is detected, the graphics engine calls WinSetErrorInfo to post the condition. Reasons for failure of this function include:
  • PMERR_BASE_ERROR
  • PMERR_FONT_FILE_NOT_LOADED
Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.

Remarks

Before unloading any fonts, the caller must ensure that:

  • The fonts are not in use for the current character set.
  • The relevant lcids have been deleted (see GreDeleteSetId).


Sample Code

#define INCL_GRE_FONTS
#include <os2.h>

PSZ      pszFilename;
PVOID    pInstance;    /*  Pointer to instance data. */
ULONG    lFunction;    /*  High-order WORD=flags; low-order WORD=NGreUnLoadFont. */
BOOL     fSuccess;     /*  Return codes. */

fSuccess = GreUnLoadFont(pszFilename, pInstance, lFunction);