Jump to content

GreDeleteSetId: Difference between revisions

From EDM2
Created page with "GreDeleteSetId deletes the character set, marker set, or pattern set identified by lcid. This function is supported by the graphics engine. == Syntax == GreDeleteSetId(hd..."
 
Ak120 (talk | contribs)
mNo edit summary
 
Line 1: Line 1:
GreDeleteSetId deletes the character set, marker set, or pattern set identified by lcid.  
GreDeleteSetId deletes the character set, marker set, or pattern set identified by lcid.


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


== Syntax ==  
== Syntax ==  
  GreDeleteSetId(hdc, lcid, pInstance, lFunction);
  GreDeleteSetId(hdc, lcid, pInstance, lFunction)


== Parameters ==
== Parameters ==
; hdc (HDC) - input : Device context handle.  
;hdc (HDC) - input : Device context handle.
 
;lcid (LONG) - input : Local identifier.
; lcid (LONG) - input : Local identifier.  
:When identifying a bit map, only the lcid is deleted. The bit map will have no LCID but it will still exist. When lcid=LCID_ALL, all loaded graphics local identifiers such as logical fonts and bit-map IDs are destroyed. In this case, AVIO fonts are unaffected and can only be explicitly deleted.
 
:LCID_AVIO_1, LCID_AVIO_2, and LCID_AVIO_3 represent AVIO fonts 1, 2, and 3, respectively.
:When identifying a bit map, only the lcid is deleted. The bit map will have no LCID but it will still exist. When lcid=LCID_ALL, all loaded graphics local identifiers such as logical fonts and bit-map IDs are destroyed. In this case, AVIO fonts are unaffected and can only be explicitly deleted.  
;pInstance (PVOID) - input : Pointer to instance data.
 
;lFunction (ULONG) - input : High-order WORD=flags; low-order WORD=NGreDeleteSetId.
:LCID_AVIO_1, LCID_AVIO_2, and LCID_AVIO_3 represent AVIO fonts 1, 2, and 3, respectively.  
 
; pInstance (PVOID) - input : Pointer to instance data.  
 
; lFunction (ULONG) - input : High-order WORD=flags; low-order WORD=NGreDeleteSetId.  


== Returns ==
== Returns ==
; fSuccess (BOOL) - returns : Return codes.  
;fSuccess (BOOL) - returns : Return codes.
 
On completion, the handling routine must return BOOLEAN (fSuccess).
On completion, the handling routine must return BOOLEAN (fSuccess).  
* TRUE Successful
* TRUE Successful  
* FALSE Error
* 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_COORDINATE_OVERFLOW
*PMERR_DEV_FUNC_NOT_INSTALLED
*PMERR_HDC_BUSY
*PMERR_INSUFFICIENT_MEMORY
*PMERR_INV_CODEPAGE
*PMERR_INV_COORD_SPACE
*PMERR_INV_EXTENDED_LCID
*PMERR_INV_FONTDEF
*PMERR_INV_HDC
*PMERR_INV_IN_AREA
*PMERR_INV_LENGTH_OR_COUNT
*PMERR_INV_SETID
*PMERR_SETID_IN_USE
*PMERR_SETID_NOT_FOUND
 
Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.


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_COORDINATE_OVERFLOW
*PMERR_DEV_FUNC_NOT_INSTALLED
*PMERR_HDC_BUSY
*PMERR_INSUFFICIENT_MEMORY
*PMERR_INV_CODEPAGE
*PMERR_INV_COORD_SPACE
*PMERR_INV_EXTENDED_LCID
*PMERR_INV_FONTDEF
*PMERR_INV_HDC
*PMERR_INV_IN_AREA
*PMERR_INV_LENGTH_OR_COUNT
*PMERR_INV_SETID
*PMERR_SETID_IN_USE
*PMERR_SETID_NOT_FOUND
Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.


== Sample ==
== Sample ==
Line 60: Line 52:


== Remarks ==
== Remarks ==
Base sets cannot be deleted. An error is logged if GreDeleteSetId is called to delete the current character, marker, or pattern set.  
Base sets cannot be deleted. An error is logged if GreDeleteSetId is called to delete the current character, marker, or pattern set.


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

Latest revision as of 18:16, 5 April 2025

GreDeleteSetId deletes the character set, marker set, or pattern set identified by lcid.

This function is supported by the graphics engine.

Syntax

GreDeleteSetId(hdc, lcid, pInstance, lFunction)

Parameters

hdc (HDC) - input
Device context handle.
lcid (LONG) - input
Local identifier.
When identifying a bit map, only the lcid is deleted. The bit map will have no LCID but it will still exist. When lcid=LCID_ALL, all loaded graphics local identifiers such as logical fonts and bit-map IDs are destroyed. In this case, AVIO fonts are unaffected and can only be explicitly deleted.
LCID_AVIO_1, LCID_AVIO_2, and LCID_AVIO_3 represent AVIO fonts 1, 2, and 3, respectively.
pInstance (PVOID) - input
Pointer to instance data.
lFunction (ULONG) - input
High-order WORD=flags; low-order WORD=NGreDeleteSetId.

Returns

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_COORDINATE_OVERFLOW
  • PMERR_DEV_FUNC_NOT_INSTALLED
  • PMERR_HDC_BUSY
  • PMERR_INSUFFICIENT_MEMORY
  • PMERR_INV_CODEPAGE
  • PMERR_INV_COORD_SPACE
  • PMERR_INV_EXTENDED_LCID
  • PMERR_INV_FONTDEF
  • PMERR_INV_HDC
  • PMERR_INV_IN_AREA
  • PMERR_INV_LENGTH_OR_COUNT
  • PMERR_INV_SETID
  • PMERR_SETID_IN_USE
  • PMERR_SETID_NOT_FOUND

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

Sample

#define INCL_GRE_SETID
#include <os2.h>

HDC      hdc;        /*  Device context handle. */
LONG     lcid;       /*  Local identifier. */
PVOID    pInstance;  /*  Pointer to instance data. */
ULONG    lFunction;  /*  High-order WORD=flags; low-order WORD=NGreDeleteSetId. */
BOOL     fSuccess;   /*  Return codes. */

fSuccess = GreDeleteSetId(hdc, lcid, pInstance, lFunction);

Remarks

Base sets cannot be deleted. An error is logged if GreDeleteSetId is called to delete the current character, marker, or pattern set.