Jump to content

GreDeleteJournalFile: Difference between revisions

From EDM2
Created page with "GreDeleteJournalFile deletes a journal file and frees any objects associated with the journal file handle (such as compatible DCs, private clone regions or bit maps, and globa..."
 
Ak120 (talk | contribs)
35,819 edits
mNo edit summary
 
Line 1: Line 1:
GreDeleteJournalFile deletes a journal file and frees any objects associated with the journal file handle (such as compatible DCs, private clone regions or bit maps, and global memory segments).  
GreDeleteJournalFile deletes a journal file and frees any objects associated with the journal file handle (such as compatible DCs, private clone regions or bit maps, and global memory segments).


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


== Syntax ==  
== Syntax ==
  GreDeleteJournalFile(hJournal, pInstance, lFunction);
  GreDeleteJournalFile(hJournal, pInstance, lFunction)


== Parameters ==
== Parameters ==
;hJournal (ULONG) - input  
;hJournal (ULONG) - input:Journal file handle.
:Journal file handle.  
;pInstance (PVOID) - input:Pointer to instance data.
 
;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreDeleteJournalFile.
;pInstance (PVOID) - input  
:Pointer to instance data.  
 
;lFunction (ULONG) - input  
:High-order WORD=flags; low-order WORD=NGreDeleteJournalFile.  


== Returns ==
== Returns ==
;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
 
:*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  
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_BITMAP_IS_SELECTED  
*PMERR_BASE_ERROR
:*PMERR_COORDINATE_OVERFLOW  
*PMERR_BITMAP_IS_SELECTED
:*PMERR_DEV_FUNC_NOT_INSTALLED  
*PMERR_COORDINATE_OVERFLOW
:*PMERR_EXCEEDS_MAX_SEG_LENGTH  
*PMERR_DEV_FUNC_NOT_INSTALLED
:*PMERR_HBITMAP_BUSY  
*PMERR_EXCEEDS_MAX_SEG_LENGTH
:*PMERR_HDC_BUSY  
*PMERR_HBITMAP_BUSY
:*PMERR_HRGN_BUSY  
*PMERR_HDC_BUSY
:*PMERR_HUGE_FONTS_NOT_SUPPORTED  
*PMERR_HRGN_BUSY
:*PMERR_INSUFFICIENT_MEMORY  
*PMERR_HUGE_FONTS_NOT_SUPPORTED
:*PMERR_INV_BACKGROUND_COL_ATTR  
*PMERR_INSUFFICIENT_MEMORY
:*PMERR_INV_BACKGROUND_MIX_ATTR  
*PMERR_INV_BACKGROUND_COL_ATTR
:*PMERR_INV_BITMAP_DIMENSION  
*PMERR_INV_BACKGROUND_MIX_ATTR
:*PMERR_INV_CHAR_DIRECTION_ATTR  
*PMERR_INV_BITMAP_DIMENSION
:*PMERR_INV_CHAR_MODE_ATTR  
*PMERR_INV_CHAR_DIRECTION_ATTR
:*PMERR_INV_CHAR_SET_ATTR  
*PMERR_INV_CHAR_MODE_ATTR
:*PMERR_INV_CHAR_SHEAR_ATTR  
*PMERR_INV_CHAR_SET_ATTR
:*PMERR_INV_CODEPAGE  
*PMERR_INV_CHAR_SHEAR_ATTR
:*PMERR_INV_COLOR_ATTR  
*PMERR_INV_CODEPAGE
:*PMERR_INV_COORD_SPACE  
*PMERR_INV_COLOR_ATTR
:*PMERR_INV_COORDINATE  
*PMERR_INV_COORD_SPACE
:*PMERR_INV_DC_TYPE  
*PMERR_INV_COORDINATE
:*PMERR_INV_GEOM_LINE_WIDTH_ATTR  
*PMERR_INV_DC_TYPE
:*PMERR_INV_HBITMAP  
*PMERR_INV_GEOM_LINE_WIDTH_ATTR
:*PMERR_INV_HDC  
*PMERR_INV_HBITMAP
:*PMERR_INV_HJOURNAL  
*PMERR_INV_HDC
:*PMERR_INV_HRGN  
*PMERR_INV_HJOURNAL
:*PMERR_INV_ID  
*PMERR_INV_HRGN
:*PMERR_INV_IN_AREA  
*PMERR_INV_ID
:*PMERR_INV_IN_PATH  
*PMERR_INV_IN_AREA
:*PMERR_INV_INFO_TABLE  
*PMERR_INV_IN_PATH
:*PMERR_INV_LENGTH_OR_COUNT  
*PMERR_INV_INFO_TABLE
:*PMERR_INV_LINE_END_ATTR  
*PMERR_INV_LENGTH_OR_COUNT
:*PMERR_INV_LINE_JOIN_ATTR  
*PMERR_INV_LINE_END_ATTR
:*PMERR_INV_LINE_TYPE_ATTR  
*PMERR_INV_LINE_JOIN_ATTR
:*PMERR_INV_LINE_WIDTH_ATTR  
*PMERR_INV_LINE_TYPE_ATTR
:*PMERR_INV_MARKER_SET_ATTR  
*PMERR_INV_LINE_WIDTH_ATTR
:*PMERR_INV_MARKER_SYMBOL_ATTR  
*PMERR_INV_MARKER_SET_ATTR
:*PMERR_INV_METAFILE  
*PMERR_INV_MARKER_SYMBOL_ATTR
:*PMERR_INV_MIX_ATTR  
*PMERR_INV_METAFILE
:*PMERR_INV_PATTERN_REF_PT_ATTR  
*PMERR_INV_MIX_ATTR
:*PMERR_INV_PATTERN_SET_ATTR  
*PMERR_INV_PATTERN_REF_PT_ATTR
:*PMERR_INV_PATTERN_SET_FONT  
*PMERR_INV_PATTERN_SET_ATTR
:*PMERR_INV_PRIMITIVE_TYPE  
*PMERR_INV_PATTERN_SET_FONT
:*PMERR_INV_RECT  
*PMERR_INV_PRIMITIVE_TYPE
:*PMERR_INV_REGION_CONTROL  
*PMERR_INV_RECT
:*PMERR_INV_SCAN_START  
*PMERR_INV_REGION_CONTROL
:*PMERR_INV_SETID  
*PMERR_INV_SCAN_START
:*PMERR_JFILE_BUSY  
*PMERR_INV_SETID
:*PMERR_REGION_IS_CLIP_REGION  
*PMERR_JFILE_BUSY
:*PMERR_UNSUPPORTED_ATTR  
*PMERR_REGION_IS_CLIP_REGION
:*PMERR_UNSUPPORTED_ATTR_VALUE  
*PMERR_UNSUPPORTED_ATTR
*PMERR_UNSUPPORTED_ATTR_VALUE


:Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.  
:Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.  
Line 92: Line 83:
BOOL    fSuccess;  /*  Return codes. */
BOOL    fSuccess;  /*  Return codes. */


fSuccess = GreDeleteJournalFile(hJournal,
fSuccess = GreDeleteJournalFile(hJournal, pInstance, lFunction);
            pInstance, lFunction);
</pre>
</pre>


== Remarks ==
== Remarks ==
When the handle belongs to a temporary file, the file is also deleted. Finally, the file handle itself is freed.  
When the handle belongs to a temporary file, the file is also deleted. Finally, the file handle itself is freed.


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

Latest revision as of 15:36, 3 April 2025

GreDeleteJournalFile deletes a journal file and frees any objects associated with the journal file handle (such as compatible DCs, private clone regions or bit maps, and global memory segments).

This function is supported by the graphics engine.

Syntax

GreDeleteJournalFile(hJournal, pInstance, lFunction)

Parameters

hJournal (ULONG) - input
Journal file handle.
pInstance (PVOID) - input
Pointer to instance data.
lFunction (ULONG) - input
High-order WORD=flags; low-order WORD=NGreDeleteJournalFile.

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_BASE_ERROR
  • PMERR_BITMAP_IS_SELECTED
  • PMERR_COORDINATE_OVERFLOW
  • PMERR_DEV_FUNC_NOT_INSTALLED
  • PMERR_EXCEEDS_MAX_SEG_LENGTH
  • PMERR_HBITMAP_BUSY
  • PMERR_HDC_BUSY
  • PMERR_HRGN_BUSY
  • PMERR_HUGE_FONTS_NOT_SUPPORTED
  • PMERR_INSUFFICIENT_MEMORY
  • PMERR_INV_BACKGROUND_COL_ATTR
  • PMERR_INV_BACKGROUND_MIX_ATTR
  • PMERR_INV_BITMAP_DIMENSION
  • PMERR_INV_CHAR_DIRECTION_ATTR
  • PMERR_INV_CHAR_MODE_ATTR
  • PMERR_INV_CHAR_SET_ATTR
  • PMERR_INV_CHAR_SHEAR_ATTR
  • PMERR_INV_CODEPAGE
  • PMERR_INV_COLOR_ATTR
  • PMERR_INV_COORD_SPACE
  • PMERR_INV_COORDINATE
  • PMERR_INV_DC_TYPE
  • PMERR_INV_GEOM_LINE_WIDTH_ATTR
  • PMERR_INV_HBITMAP
  • PMERR_INV_HDC
  • PMERR_INV_HJOURNAL
  • 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_LINE_END_ATTR
  • PMERR_INV_LINE_JOIN_ATTR
  • PMERR_INV_LINE_TYPE_ATTR
  • PMERR_INV_LINE_WIDTH_ATTR
  • PMERR_INV_MARKER_SET_ATTR
  • PMERR_INV_MARKER_SYMBOL_ATTR
  • PMERR_INV_METAFILE
  • PMERR_INV_MIX_ATTR
  • PMERR_INV_PATTERN_REF_PT_ATTR
  • PMERR_INV_PATTERN_SET_ATTR
  • PMERR_INV_PATTERN_SET_FONT
  • PMERR_INV_PRIMITIVE_TYPE
  • PMERR_INV_RECT
  • PMERR_INV_REGION_CONTROL
  • PMERR_INV_SCAN_START
  • PMERR_INV_SETID
  • PMERR_JFILE_BUSY
  • PMERR_REGION_IS_CLIP_REGION
  • PMERR_UNSUPPORTED_ATTR
  • PMERR_UNSUPPORTED_ATTR_VALUE
Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.

Sample

#define INCL_GRE_JOURNALING
#include <os2.h>

ULONG    hJournal;   /*  Journal file handle. */
PVOID    pInstance;  /*  Pointer to instance data. */
ULONG    lFunction;  /*  High-order WORD=flags; low-order WORD=NGreDeleteJournalFile. */
BOOL     fSuccess;   /*  Return codes. */

fSuccess = GreDeleteJournalFile(hJournal, pInstance, lFunction);

Remarks

When the handle belongs to a temporary file, the file is also deleted. Finally, the file handle itself is freed.

Retrieved from "https://www.edm2.com/index.php?title=GreDeleteJournalFile&oldid=84199"