hdc (HDC) - input

Device context handle.

hrgn (HRGN) - input

Visible region handle.

prclBounds (PRECTL) - input

Pointer to the bounding rectangle of the returned region.

The bounding rectangle is returned in the same coordinate system as the region defined by flOptions. This rectangle is inclusive at the bottom and left boundaries, exclusive at the top and right boundaries. When specified as NULL, the bounding rectangle is not returned.

flOptions (ULONG) - input

These flags determine the type of region to be returned in hrgn:

COPYCRGN_ALLINTERSECT

The function must return the intersection of all clipping. This value describes the DC region and is expressed in screen coordinates.
COPYCRGN_VISRGN
The function must return a copy of the visible region only. This value is returned in screen coordinates.
COPYCRGN_CLIPRGN
The function must return a copy of the clip region only. The clip region is expressed in device coordinates.

pInstance (PVOID) - input

Pointer to instance data.

lFunction (ULONG) - input

High-order WORD=flags; low-order WORD=NGreCopyClipRegion.

rc (LONG) - returns

Return codes.

This function returns an integer (lComplexity) indicating the complexity of the region:

RGN_ERROR

Error
RGN_NULL
Null region
RGN_RECT
Rectangular region
RGN_COMPLEX
Complex region (more than one rectangle)
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_REGION_IS_CLIP_REGION

Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.

---

[Back: GreCopyClipRegion Return Value - rc]
[Next: GreCopyClipRegion - Topics]