Jump to content

GreResetDC: Difference between revisions

From EDM2
Created page with "GreResetDC restores a device context to its created state. This function is supported by the graphics engine. ==Syntax== GreResetDC(hdc, flOptions, pInstance, lFunction);..."
 
Ak120 (talk | contribs)
mNo edit summary
 
Line 1: Line 1:
GreResetDC restores a device context to its created state.  
GreResetDC restores a device context to its created state.


This function is supported by the graphics engine.  
This function is supported by the graphics engine.


==Syntax==
==Syntax==
  GreResetDC(hdc, flOptions, pInstance, lFunction);
  GreResetDC(hdc, flOptions, pInstance, lFunction)
 
==Parameters==
==Parameters==
;hdc (HDC) - input  
;hdc (HDC) - input:Device context handle.
:Device context handle.  
;flOptions (ULONG) - input:Option flags.
 
:Valid flags are:
;flOptions (ULONG) - input  
::RDC_SETOWNERTOSHELL: When set, the graphics engine sets the ownership of the reset DC to the process that first initialized the engine, (normally the Presentation Manager interface).
:Option flags.  
::RDC_RGBMODE: Sets the DC's logical color table to RGB mode.
 
;pInstance (PVOID) - input:Pointer to instance data.
:Valid flags are:  
;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreResetDC.
 
:;RDC_SETOWNERTOSHELL  
::When set, the graphics engine sets the ownership of the reset DC to the process that first initialized the engine, (normally the Presentation Manager interface).  
 
:;RDC_RGBMODE  
::Sets the DC's logical color table to RGB mode.  
 
;pInstance (PVOID) - input  
:Pointer to instance data.  
 
;lFunction (ULONG) - input  
:High-order WORD=flags; low-order WORD=NGreResetDC.  


==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_BASE_ERROR
:*FALSE Error  
:*PMERR_BITMAP_IS_SELECTED
 
:*PMERR_DEV_FUNC_NOT_INSTALLED
: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_EXCEEDS_MAX_SEG_LENGTH
 
:*PMERR_HBITMAP_BUSY
:*PMERR_BASE_ERROR  
:*PMERR_HDC_BUSY
:*PMERR_BITMAP_IS_SELECTED  
:*PMERR_INSUFFICIENT_MEMORY
:*PMERR_DEV_FUNC_NOT_INSTALLED  
:*PMERR_INV_BITMAP_DIMENSION
:*PMERR_EXCEEDS_MAX_SEG_LENGTH  
:*PMERR_INV_CODEPAGE
:*PMERR_HBITMAP_BUSY  
:*PMERR_INV_COORDINATE
:*PMERR_HDC_BUSY  
:*PMERR_INV_DC_TYPE
:*PMERR_INSUFFICIENT_MEMORY  
:*PMERR_INV_HBITMAP
:*PMERR_INV_BITMAP_DIMENSION  
:*PMERR_INV_HDC
:*PMERR_INV_CODEPAGE  
:*PMERR_INV_HRGN
:*PMERR_INV_COORDINATE  
:*PMERR_INV_ID
:*PMERR_INV_DC_TYPE  
:*PMERR_INV_IN_AREA
:*PMERR_INV_HBITMAP  
:*PMERR_INV_IN_PATH
:*PMERR_INV_HDC  
:*PMERR_INV_INFO_TABLE
:*PMERR_INV_HRGN  
:*PMERR_INV_LENGTH_OR_COUNT
:*PMERR_INV_ID  
:*PMERR_INV_RECT
:*PMERR_INV_IN_AREA  
:*PMERR_INV_REGION_CONTROL
:*PMERR_INV_IN_PATH  
:*PMERR_INV_SCAN_START
:*PMERR_INV_INFO_TABLE  
:Refer to the "Error Explanations" section of the ''Presentation Manager Programming Reference'' for further explanation.
:*PMERR_INV_LENGTH_OR_COUNT  
:*PMERR_INV_RECT  
:*PMERR_INV_REGION_CONTROL  
:*PMERR_INV_SCAN_START  
 
:Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.  


==Remarks==
==Remarks==
All objects, such as fonts, patterns, and paths, are deleted. All attributes are set to their defaults. Any clip region selected into the DC is deleted.  
All objects, such as fonts, patterns, and paths, are deleted. All attributes are set to their defaults. Any clip region selected into the DC is deleted.
 
This function does not alter Window Manager information stored in the DC instance data. Window Manager information includes:
*The visible region
*The DC origin
*User bounds
*Cached clipping rectangles
*The HDC_IS_DIRTY flag
 
==Sample Code==
<PRE>
 
#define INCL_GRE_DCS
#include <os2.h>
 
HDC      hdc;        /*  Device context handle. */
ULONG    flOptions;  /*  Option flags. */
PVOID    pInstance;  /*  Pointer to instance data. */
ULONG    lFunction;  /*  High-order WORD=flags; low-order WORD=NGreResetDC. */
BOOL    fSuccess;  /*  Return codes. */


fSuccess = GreResetDC(hdc, flOptions, pInstance,
This function does not alter Window Manager information stored in the DC instance data. Window Manager information includes:
            lFunction);
*The visible region
</PRE>
*The DC origin
*User bounds
*Cached clipping rectangles
*The HDC_IS_DIRTY flag


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

Latest revision as of 07:47, 5 March 2020

GreResetDC restores a device context to its created state.

This function is supported by the graphics engine.

Syntax

GreResetDC(hdc, flOptions, pInstance, lFunction)

Parameters

hdc (HDC) - input
Device context handle.
flOptions (ULONG) - input
Option flags.
Valid flags are:
RDC_SETOWNERTOSHELL: When set, the graphics engine sets the ownership of the reset DC to the process that first initialized the engine, (normally the Presentation Manager interface).
RDC_RGBMODE: Sets the DC's logical color table to RGB mode.
pInstance (PVOID) - input
Pointer to instance data.
lFunction (ULONG) - input
High-order WORD=flags; low-order WORD=NGreResetDC.

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_BASE_ERROR
  • PMERR_BITMAP_IS_SELECTED
  • PMERR_DEV_FUNC_NOT_INSTALLED
  • PMERR_EXCEEDS_MAX_SEG_LENGTH
  • PMERR_HBITMAP_BUSY
  • PMERR_HDC_BUSY
  • PMERR_INSUFFICIENT_MEMORY
  • PMERR_INV_BITMAP_DIMENSION
  • PMERR_INV_CODEPAGE
  • PMERR_INV_COORDINATE
  • PMERR_INV_DC_TYPE
  • PMERR_INV_HBITMAP
  • PMERR_INV_HDC
  • PMERR_INV_HRGN
  • PMERR_INV_ID
  • PMERR_INV_IN_AREA
  • PMERR_INV_IN_PATH
  • PMERR_INV_INFO_TABLE
  • PMERR_INV_LENGTH_OR_COUNT
  • PMERR_INV_RECT
  • PMERR_INV_REGION_CONTROL
  • PMERR_INV_SCAN_START
Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.

Remarks

All objects, such as fonts, patterns, and paths, are deleted. All attributes are set to their defaults. Any clip region selected into the DC is deleted.

This function does not alter Window Manager information stored in the DC instance data. Window Manager information includes:

  • The visible region
  • The DC origin
  • User bounds
  • Cached clipping rectangles
  • The HDC_IS_DIRTY flag