Jump to content

GreQueryFontAttributes: Difference between revisions

From EDM2
Created page with "GreQueryFontAttributes returns the metrics of the current font at the location addressed by pfmMetrics. This function is supported by the graphics engine. == Syntax == G..."
 
Ak120 (talk | contribs)
mNo edit summary
 
Line 1: Line 1:
GreQueryFontAttributes returns the metrics of the current font at the location addressed by pfmMetrics.  
GreQueryFontAttributes returns the metrics of the current font at the location addressed by pfmMetrics.


This function is supported by the graphics engine.  
This function is supported by the graphics engine.


== Syntax ==  
== Syntax ==  
  GreQueryFontAttributes(hdc, cbMetrics, pfmMetrics, pInstance, lFunction);
  GreQueryFontAttributes(hdc, cbMetrics, pfmMetrics, pInstance, lFunction)


== Parameters ==
== Parameters ==
;hdc (HDC) - input  
;hdc (HDC) - input:Device context handle.
:Device context handle.  
;cbMetrics (LONG) - input:Size in bytes of the font metrics buffer.
 
;pfmMetrics (PFONTMETRICS) - input:Pointer.
;cbMetrics (LONG) - input  
:Pointer to font metric block where the information is to be returned.
:Size in bytes of the font metrics buffer.  
;pInstance (PVOID) - input:Pointer to instance data.
 
;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreQueryFontAttributes.
;pfmMetrics (PFONTMETRICS) - input  
:Pointer.  
 
:Pointer to font metric block where the information is to be returned.  
 
;pInstance (PVOID) - input  
:Pointer to instance data.  
 
;lFunction (ULONG) - input  
:High-order WORD=flags; low-order WORD=NGreQueryFontAttributes.  


== Returns ==
== Returns ==
;fSuccess (BOOL) - returns  
;fSuccess (BOOL) - returns:Return codes.
:Return codes.  
:On completion, the handling routine must return BOOLEAN (fSuccess).
 
:*TRUE Successful
:On completion, the handling routine must return BOOLEAN (fSuccess).  
:*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:
:*TRUE Successful  
:*PMERR_COORDINATE_OVERFLOW
:*FALSE Error  
:*PMERR_DEV_FUNC_NOT_INSTALLED
 
:*PMERR_HDC_BUSY
;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_INV_COORD_SPACE
 
:*PMERR_INV_HDC
:*PMERR_COORDINATE_OVERFLOW  
:*PMERR_INV_LENGTH_OR_COUNT
:*PMERR_DEV_FUNC_NOT_INSTALLED  
:*PMERR_INV_SETID
:*PMERR_HDC_BUSY  
:Refer to the "Error Explanations" section of the ''Presentation Manager Programming Reference'' for further explanation.
:*PMERR_INV_COORD_SPACE  
:*PMERR_INV_HDC  
:*PMERR_INV_LENGTH_OR_COUNT  
:*PMERR_INV_SETID  
 
:Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.  


== Sample ==
== Sample ==

Latest revision as of 23:26, 24 March 2020

GreQueryFontAttributes returns the metrics of the current font at the location addressed by pfmMetrics.

This function is supported by the graphics engine.

Syntax

GreQueryFontAttributes(hdc, cbMetrics, pfmMetrics, pInstance, lFunction)

Parameters

hdc (HDC) - input
Device context handle.
cbMetrics (LONG) - input
Size in bytes of the font metrics buffer.
pfmMetrics (PFONTMETRICS) - input
Pointer.
Pointer to font metric block where the information is to be returned.
pInstance (PVOID) - input
Pointer to instance data.
lFunction (ULONG) - input
High-order WORD=flags; low-order WORD=NGreQueryFontAttributes.

Returns

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_COORDINATE_OVERFLOW
  • PMERR_DEV_FUNC_NOT_INSTALLED
  • PMERR_HDC_BUSY
  • PMERR_INV_COORD_SPACE
  • PMERR_INV_HDC
  • PMERR_INV_LENGTH_OR_COUNT
  • PMERR_INV_SETID
Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.

Sample

#define INCL_GRE_FONTS
#include <os2.h>

HDC             hdc;         /*  Device context handle. */
LONG            cbMetrics;   /*  Size in bytes of the font metrics buffer. */
PFONTMETRICS    pfmMetrics;  /*  Pointer. */
PVOID           pInstance;   /*  Pointer to instance data. */
ULONG           lFunction;   /*  High-order WORD=flags; low-order WORD=NGreQueryFontAttributes. */
BOOL            fSuccess;    /*  Return codes. */

fSuccess = GreQueryFontAttributes(hdc, cbMetrics,
             pfmMetrics, pInstance, lFunction);