Jump to content

GreGetArcParameters: Difference between revisions

From EDM2
Created page with "GreGetArcParameters stores the current arc parameters in the buffer addressed by pArcParms. This function can be hooked by the presentation driver. ;Simulation support: Th..."
 
Ak120 (talk | contribs)
mNo edit summary
 
Line 1: Line 1:
GreGetArcParameters stores the current arc parameters in the buffer addressed by pArcParms.  
GreGetArcParameters stores the current arc parameters in the buffer addressed by pArcParms.


This function can be hooked by the presentation driver.  
This function can be hooked by the presentation driver.


;Simulation support: This function is simulated by a handling routine in the graphics engine.  
;Simulation support: This function is simulated by a handling routine in the graphics engine.


== Syntax ==  
== Syntax ==  
  GreGetArcParameters(hdc, pArcParms, pInstance, lFunction);
  GreGetArcParameters(hdc, pArcParms, pInstance, lFunction)


== Parameters ==
== Parameters ==
;hdc (HDC) - input  
;hdc (HDC) - input:Device context handle.
:Device context handle.  
;pArcParms (PARCPARAMS) - input:Pointer to ARCPARAMS structure.
 
;pInstance (PVOID) - input:Pointer to instance data.
;pArcParms (PARCPARAMS) - input  
;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreGetArcParameters.
:Pointer to ARCPARAMS structure.  
 
;pInstance (PVOID) - input  
:Pointer to instance data.  
 
;lFunction (ULONG) - input  
:High-order WORD=flags; low-order WORD=NGreGetArcParameters.  


== Returns ==
== Returns ==
;fSuccess (BOOL) - returns  
;fSuccess (BOOL) - returns:Return codes.
:Return codes.  
:This function returns BOOLEAN (fSuccess).
 
:*TRUE Successful
:This function returns BOOLEAN (fSuccess).  
:*FALSE Error
 
:Possible Errors Detected: When an error is detected, the handling routine must call WinSetErrorInfo to post the condition. Error codes for conditions that the handling routine is expected to check include:
:*TRUE Successful  
:*PMERR_HDC_BUSY
:*FALSE Error  
:*PMERR_INV_HDC
 
:Refer to the "Error Explanations" section in the ''Presentation Manager Programming Reference'' for further explanation.
:Possible Errors Detected:   When an error is detected, the handling routine must call WinSetErrorInfo to post the condition. Error codes for conditions that the handling routine is expected to check include:  
 
:*PMERR_HDC_BUSY  
:*PMERR_INV_HDC  
 
:Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.  


== Sample ==
== Sample ==
Line 48: Line 35:
BOOL          fSuccess;  /*  Return codes. */
BOOL          fSuccess;  /*  Return codes. */


fSuccess = GreGetArcParameters(hdc, pArcParms,
fSuccess = GreGetArcParameters(hdc, pArcParms, pInstance, lFunction);
            pInstance, lFunction);
</pre>
</pre>


[[Category:Gre]]
[[Category:Gre]]

Latest revision as of 04:30, 24 March 2020

GreGetArcParameters stores the current arc parameters in the buffer addressed by pArcParms.

This function can be hooked by the presentation driver.

Simulation support
This function is simulated by a handling routine in the graphics engine.

Syntax

GreGetArcParameters(hdc, pArcParms, pInstance, lFunction)

Parameters

hdc (HDC) - input
Device context handle.
pArcParms (PARCPARAMS) - input
Pointer to ARCPARAMS structure.
pInstance (PVOID) - input
Pointer to instance data.
lFunction (ULONG) - input
High-order WORD=flags; low-order WORD=NGreGetArcParameters.

Returns

fSuccess (BOOL) - returns
Return codes.
This function returns BOOLEAN (fSuccess).
  • TRUE Successful
  • FALSE Error
Possible Errors Detected: When an error is detected, the handling routine must call WinSetErrorInfo to post the condition. Error codes for conditions that the handling routine is expected to check include:
  • PMERR_HDC_BUSY
  • PMERR_INV_HDC
Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.

Sample

#define INCL_GRE_ARCS
#include <os2.h>

HDC           hdc;        /*  Device context handle. */
PARCPARAMS    pArcParms;  /*  Pointer to ARCPARAMS structure. */
PVOID         pInstance;  /*  Pointer to instance data. */
ULONG         lFunction;  /*  High-order WORD=flags; low-order WORD=NGreGetArcParameters. */
BOOL          fSuccess;   /*  Return codes. */

fSuccess = GreGetArcParameters(hdc, pArcParms, pInstance, lFunction);