Jump to content

GreSelectPathRegion: Difference between revisions

From EDM2
Created page with "GreSelectPathRegion merges a region representing a path into the DC region. A "path region" behaves exactly like any other region. It has no special properties relating to pat..."
 
Ak120 (talk | contribs)
mNo edit summary
 
Line 1: Line 1:
GreSelectPathRegion merges a region representing a path into the DC region. A "path region" behaves exactly like any other region. It has no special properties relating to paths.  
GreSelectPathRegion merges a region representing a path into the DC region. A "path region" behaves exactly like any other region. It has no special properties relating to paths.


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==
  GreSelectPathRegion(hdc, hrgn, pInstance, lFunction);
  GreSelectPathRegion(hdc, hrgn, pInstance, lFunction)


==Parameters==
==Parameters==
;hdc (HDC) - input  
;hdc (HDC) - input:Device context handle.
:Device context handle.  
;hrgn (HRGN) - input:Region handle.
 
;pInstance (PVOID) - input:Pointer to instance data.
;hrgn (HRGN) - input  
;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreSelectPathRegion.
:Region handle.  
 
;pInstance (PVOID) - input  
:Pointer to instance data.  
 
;lFunction (ULONG) - input  
:High-order WORD=flags; low-order WORD=NGreSelectPathRegion.  


==Return Code==
==Return Code==
;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_DEV_FUNC_NOT_INSTALLED
:*FALSE Error  
:*PMERR_HDC_BUSY
 
:*PMERR_HRGN_BUSY
;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_INSUFFICIENT_MEMORY
 
:*PMERR_INV_COORDINATE
:*PMERR_DEV_FUNC_NOT_INSTALLED  
:*PMERR_INV_HDC
:*PMERR_HDC_BUSY  
:*PMERR_INV_HRGN
:*PMERR_HRGN_BUSY  
:*PMERR_INV_RECT
:*PMERR_INSUFFICIENT_MEMORY  
:*PMERR_INV_REGION_CONTROL
:*PMERR_INV_COORDINATE  
:*PMERR_REGION_IS_CLIP_REGION
:*PMERR_INV_HDC  
:Refer to the "Error Explanations" section in the ''Presentation Manager Programming Reference'' for further explanation.
:*PMERR_INV_HRGN  
:*PMERR_INV_RECT  
:*PMERR_INV_REGION_CONTROL  
:*PMERR_REGION_IS_CLIP_REGION  
 
:Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.  


==Declaration==
==Declaration==
<PRE>
<PRE>
#define INCL_GRE_CLIP
#define INCL_GRE_CLIP
#include <os2.h>
#include <os2.h>
Line 58: Line 44:


fSuccess = GreSelectPathRegion(hdc, hrgn, pInstance, lFunction);
fSuccess = GreSelectPathRegion(hdc, hrgn, pInstance, lFunction);
</PRE>
</PRE>


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

Latest revision as of 23:37, 23 March 2020

GreSelectPathRegion merges a region representing a path into the DC region. A "path region" behaves exactly like any other region. It has no special properties relating to paths.

This function can be hooked by the presentation driver.

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

Syntax

GreSelectPathRegion(hdc, hrgn, pInstance, lFunction)

Parameters

hdc (HDC) - input
Device context handle.
hrgn (HRGN) - input
Region handle.
pInstance (PVOID) - input
Pointer to instance data.
lFunction (ULONG) - input
High-order WORD=flags; low-order WORD=NGreSelectPathRegion.

Return Code

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_DEV_FUNC_NOT_INSTALLED
  • PMERR_HDC_BUSY
  • PMERR_HRGN_BUSY
  • PMERR_INSUFFICIENT_MEMORY
  • PMERR_INV_COORDINATE
  • PMERR_INV_HDC
  • PMERR_INV_HRGN
  • PMERR_INV_RECT
  • PMERR_INV_REGION_CONTROL
  • PMERR_REGION_IS_CLIP_REGION
Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.

Declaration

#define INCL_GRE_CLIP
#include <os2.h>

HDC      hdc;        /*  Device context handle. */
HRGN     hrgn;       /*  Region handle. */
PVOID    pInstance;  /*  Pointer to instance data. */
ULONG    lFunction;  /*  High-order WORD=flags; low-order WORD=NGreSelectPathRegion. */
BOOL     fSuccess;   /*  Return codes. */

fSuccess = GreSelectPathRegion(hdc, hrgn, pInstance, lFunction);