Jump to content

GreUnrealizeColorTable: Difference between revisions

From EDM2
Created page with "GreUnrealizeColorTable reverses GreRealizeColorTable by causing the default physical color table for the device to be reinstated. This function must be supported by the pres..."
 
Ak120 (talk | contribs)
mNo edit summary
 
Line 1: Line 1:
GreUnrealizeColorTable reverses GreRealizeColorTable by causing the default physical color table for the device to be reinstated.  
GreUnrealizeColorTable reverses [[GreRealizeColorTable]] by causing the default physical color table for the device to be reinstated.


This function must be supported by the presentation driver. GreUnrealizeColorTable is called by GpiUnRealizeColorTable in response to the request of an application to restore the application's logical color table prior to the last call to GpiRealizeColorTable. This function can be handled by bit-map simulation.  
This function must be supported by the presentation driver. GreUnrealizeColorTable is called by GpiUnRealizeColorTable in response to the request of an application to restore the application's logical color table prior to the last call to GpiRealizeColorTable. This function can be handled by bit-map simulation.


; Simulation support: None. This function is mandatory for all drivers.
;Simulation support: None. This function is mandatory for all drivers.


== Syntax ==  
== Syntax ==  
  GreUnrealizeColorTable(hdc, pInstance, lFunction);
  GreUnrealizeColorTable(hdc, pInstance, lFunction)


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


== Returns ==
== Returns ==
; rc (BOOL) - returns : Return codes.  
;rc (BOOL) - returns : Return codes.
 
On completion, the handling routine must return a BOOLEAN value to indicate success or an error.
On completion, the handling routine must return a BOOLEAN value to indicate success or an error.  
*TRUE Successful
*TRUE Successful  
*FALSE Error
*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_COL_TABLE_NOT_REALIZED
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_COL_TABLE_NOT_REALIZED  
*PMERR_INV_HDC
*PMERR_DEV_FUNC_NOT_INSTALLED  
*PMERR_INV_IN_AREA
*PMERR_INV_HDC  
*PMERR_INV_IN_PATH
*PMERR_INV_IN_AREA  
Refer to the "Error Explanations" section in the ''Presentation Manager Programming Reference'' for further explanation.
*PMERR_INV_IN_PATH  
 
Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.  
 
 
== Sample ==
<pre>
#define INCL_GRE_COLORTABLE
#include <os2.h>
 
HDC      hdc;        /*  Device context handle. */
PVOID    pInstance;  /*  Pointer to instance data. */
ULONG    lFunction;  /*  High-order WORD=flags; low-order WORD=NGreUnrealizeColorTable. */
BOOL    rc;        /*  Return codes. */
 
rc = GreUnrealizeColorTable(hdc, pInstance,
      lFunction);
 
</pre>


== Remarks ==
== Remarks ==
The logical color table is unaffected by this function.
The logical color table is unaffected by this function.
 
; Note: GreUnrealizeColorTable is provided for the support of older applications and is of less importance for new applications.  


;Note: GreUnrealizeColorTable is provided for the support of older applications and is of less importance for new applications.


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

Latest revision as of 23:20, 17 January 2020

GreUnrealizeColorTable reverses GreRealizeColorTable by causing the default physical color table for the device to be reinstated.

This function must be supported by the presentation driver. GreUnrealizeColorTable is called by GpiUnRealizeColorTable in response to the request of an application to restore the application's logical color table prior to the last call to GpiRealizeColorTable. This function can be handled by bit-map simulation.

Simulation support
None. This function is mandatory for all drivers.

Syntax

GreUnrealizeColorTable(hdc, pInstance, lFunction)

Parameters

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

Returns

rc (BOOL) - returns
Return codes.

On completion, the handling routine must return a BOOLEAN value to indicate success or an error.

  • 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_COL_TABLE_NOT_REALIZED
  • PMERR_DEV_FUNC_NOT_INSTALLED
  • PMERR_INV_HDC
  • PMERR_INV_IN_AREA
  • PMERR_INV_IN_PATH

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

Remarks

The logical color table is unaffected by this function.

Note
GreUnrealizeColorTable is provided for the support of older applications and is of less importance for new applications.