GreGetDefaultArcParameters: Difference between revisions
Appearance
Created page with "GreGetDefaultArcParameters stores the default arc parameters in the buffer addressed by pArcParms. This function is supported by the graphics engine. ==Syntax== fSuccess ..." |
mNo edit summary |
||
Line 1: | Line 1: | ||
GreGetDefaultArcParameters stores the default arc parameters in the buffer addressed by pArcParms. | GreGetDefaultArcParameters stores the default arc parameters in the buffer addressed by pArcParms. | ||
This function is supported by the graphics engine. | This function is supported by the graphics engine. | ||
==Syntax== | ==Syntax== | ||
fSuccess = GreGetDefaultArcParameters(hdc, pArcParms, pInstance, lFunction) | fSuccess = GreGetDefaultArcParameters(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=NGreGetDefaultArcParameters. | ||
:Pointer to ARCPARAMS structure. | |||
;pInstance (PVOID) - input | |||
:Pointer to instance data. | |||
;lFunction (ULONG) - input | |||
:High-order WORD=flags; low-order WORD=NGreGetDefaultArcParameters. | |||
==Return Code== | ==Return Code== | ||
;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_HDC_BUSY | ||
:*FALSE Error | :*PMERR_INV_HDC | ||
:Refer to the "Error Explanations" section of the ''Presentation Manager Programming Reference'' for further explanation. | |||
:Possible Errors Detected: | |||
:*PMERR_HDC_BUSY | |||
:*PMERR_INV_HDC | |||
:Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation. | |||
==Sample Code== | ==Sample Code== | ||
Line 46: | Line 33: | ||
BOOL fSuccess; /* Return codes. */ | BOOL fSuccess; /* Return codes. */ | ||
fSuccess = GreGetDefaultArcParameters(hdc, | fSuccess = GreGetDefaultArcParameters(hdc, pArcParms, pInstance, lFunction); | ||
</PRE> | </PRE> | ||
[[Category:Gre]] | [[Category:Gre]] |
Latest revision as of 04:44, 24 March 2020
GreGetDefaultArcParameters stores the default arc parameters in the buffer addressed by pArcParms.
This function is supported by the graphics engine.
Syntax
fSuccess = GreGetDefaultArcParameters(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=NGreGetDefaultArcParameters.
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_HDC_BUSY
- PMERR_INV_HDC
- Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.
Sample Code
#define INCL_GRE_DEVSUPPORT #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=NGreGetDefaultArcParameters. */ BOOL fSuccess; /* Return codes. */ fSuccess = GreGetDefaultArcParameters(hdc, pArcParms, pInstance, lFunction);