Difference between revisions of "GreSetArcParameters"

From EDM2
Jump to: navigation, search
(Created page with "GreSetArcParameters sets the arc parameters. This function can be hooked by the presentation driver. ;Simulation support: This function is simulated by a handling routine i...")
 
m
 
Line 1: Line 1:
GreSetArcParameters sets the arc parameters.  
+
GreSetArcParameters sets the arc parameters.
  
 
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 ==  
  GreSetArcParameters(hdc, pArcParms, pInstance, lFunction);
+
  GreSetArcParameters(hdc, pArcParms, pInstance, lFunction)
  
 
== Parameters ==
 
== Parameters ==
;hdc (HDC) - input  
+
;hdc (HDC) - input:Device context handle.
:Device context handle.  
+
;pArcParms (P[[ARCPARAMS]]) - input:Pointer to an array containing the arc parameters.  
 
+
:See the ''Presentation Manager Programming Reference'' for a full description of the arc parameters structure.
;pArcParms (PARCPARAMS) - input  
+
;pInstance (PVOID) - input:Pointer to instance data.
:Pointer to an array containing the arc parameters.  
+
;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreSetArcParameters.
 
+
:ARCPARAMS structure:
+
:*lP P coefficient
+
:*lQ Q coefficient
+
:*lR R coefficient
+
:*lS S coefficient
+
 
+
:See the Presentation Manager Programming Reference for a full description of the arc parameters structure.  
+
 
+
;pInstance (PVOID) - input  
+
:Pointer to instance data.  
+
 
+
;lFunction (ULONG) - input  
+
:High-order WORD=flags; low-order WORD=NGreSetArcParameters.  
+
  
 
== 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 ==
+
<pre>
+
#define INCL_GRE_ARCS
+
#include <os2.h>
+
 
+
HDC          hdc;        /*  Device context handle. */
+
PARCPARAMS    pArcParms;  /*  Pointer to an array containing the arc parameters.
+
 
+
ARCPARAMS structure: */
+
PVOID        pInstance;  /*  Pointer to instance data. */
+
ULONG        lFunction;  /*  High-order WORD=flags; low-order WORD=NGreSetArcParameters. */
+
BOOL          fSuccess;  /*  Return codes. */
+
 
+
fSuccess = GreSetArcParameters(hdc, pArcParms,
+
            pInstance, lFunction);
+
</pre>
+
 
+
 
+
  
 
[[Category:Gre]]
 
[[Category:Gre]]

Latest revision as of 18:17, 17 January 2020

GreSetArcParameters sets the arc parameters.

This function can be hooked by the presentation driver.

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

Syntax

GreSetArcParameters(hdc, pArcParms, pInstance, lFunction)

Parameters

hdc (HDC) - input
Device context handle.
pArcParms (PARCPARAMS) - input
Pointer to an array containing the arc parameters.
See the Presentation Manager Programming Reference for a full description of the arc parameters structure.
pInstance (PVOID) - input
Pointer to instance data.
lFunction (ULONG) - input
High-order WORD=flags; low-order WORD=NGreSetArcParameters.

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.