Jump to content

GreStartJournalFile: Difference between revisions

From EDM2
Newer edit →
Created page with "GreStartJournalFile starts the journaling process. This function is supported by the graphics engine. ==Syntax== GreStartJournalFile(hdc, hJournal, pInstance, lFunction)..."
 
Ak120 (talk | contribs)
35,819 edits
mNo edit summary
Line 1: Line 1:
GreStartJournalFile starts the journaling process.  
GreStartJournalFile starts the journaling process.


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


==Syntax==
==Syntax==
  GreStartJournalFile(hdc, hJournal, pInstance, lFunction);
GreStartJournalFile(hdc, hJournal, pInstance, lFunction)
 
==Parameters==
==Parameters==
;hdc (HDC) - input  
;hdc (HDC) - input:Device context handle.
:Device context handle.  
;hJournal (ULONG) - input:Journal file handle.
 
;pInstance (PVOID) - input:Pointer to instance data.
;hJournal (ULONG) - input  
;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreStartJournalFile.
:Journal file handle.  
 
;pInstance (PVOID) - input  
:Pointer to instance data.  
 
;lFunction (ULONG) - input  
:High-order WORD=flags; low-order WORD=NGreStartJournalFile.  


==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_COORDINATE_OVERFLOW
: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_DEV_FUNC_NOT_INSTALLED
 
:*PMERR_EXCEEDS_MAX_SEG_LENGTH
:*PMERR_BASE_ERROR  
:*PMERR_HBITMAP_BUSY
:*PMERR_BITMAP_IS_SELECTED  
:*PMERR_HDC_BUSY
:*PMERR_COORDINATE_OVERFLOW  
:*PMERR_HUGE_FONTS_NOT_SUPPORTED
:*PMERR_DEV_FUNC_NOT_INSTALLED  
:*PMERR_INSUFFICIENT_MEMORY
:*PMERR_EXCEEDS_MAX_SEG_LENGTH  
:*PMERR_INV_BACKGROUND_COL_ATTR
:*PMERR_HBITMAP_BUSY  
:*PMERR_INV_BACKGROUND_MIX_ATTR
:*PMERR_HDC_BUSY  
:*PMERR_INV_BITMAP_DIMENSION
:*PMERR_HUGE_FONTS_NOT_SUPPORTED  
:*PMERR_INV_CHAR_DIRECTION_ATTR
:*PMERR_INSUFFICIENT_MEMORY  
:*PMERR_INV_CHAR_MODE_ATTR
:*PMERR_INV_BACKGROUND_COL_ATTR  
:*PMERR_INV_CODEPAGE
:*PMERR_INV_BACKGROUND_MIX_ATTR  
:*PMERR_INV_COLOR_ATTR
:*PMERR_INV_BITMAP_DIMENSION  
:*PMERR_INV_COORD_SPACE
:*PMERR_INV_CHAR_DIRECTION_ATTR  
:*PMERR_INV_COORDINATE
:*PMERR_INV_CHAR_MODE_ATTR  
:*PMERR_INV_DC_DATA
:*PMERR_INV_CODEPAGE  
:*PMERR_INV_DC_TYPE
:*PMERR_INV_COLOR_ATTR  
:*PMERR_INV_DRIVER_NAME
:*PMERR_INV_COORD_SPACE  
:*PMERR_INV_HBITMAP
:*PMERR_INV_COORDINATE  
:*PMERR_INV_HDC
:*PMERR_INV_DC_DATA  
:*PMERR_INV_HJOURNAL
:*PMERR_INV_DC_TYPE  
:*PMERR_INV_HRGN
:*PMERR_INV_DRIVER_NAME  
:*PMERR_INV_ID
:*PMERR_INV_HBITMAP  
:*PMERR_INV_IN_AREA
:*PMERR_INV_HDC  
:*PMERR_INV_IN_PATH
:*PMERR_INV_HJOURNAL  
:*PMERR_INV_INFO_TABLE
:*PMERR_INV_HRGN  
:*PMERR_INV_LENGTH_OR_COUNT
:*PMERR_INV_ID  
:*PMERR_INV_LINE_TYPE_ATTR
:*PMERR_INV_IN_AREA  
:*PMERR_INV_METAFILE
:*PMERR_INV_IN_PATH  
:*PMERR_INV_MIX_ATTR
:*PMERR_INV_INFO_TABLE  
:*PMERR_INV_PATTERN_REF_PT_ATTR
:*PMERR_INV_LENGTH_OR_COUNT  
:*PMERR_INV_PATTERN_SET_ATTR
:*PMERR_INV_LINE_TYPE_ATTR  
:*PMERR_INV_PATTERN_SET_FONT
:*PMERR_INV_METAFILE  
:*PMERR_INV_RECT
:*PMERR_INV_MIX_ATTR  
:*PMERR_INV_REGION_CONTROL
:*PMERR_INV_PATTERN_REF_PT_ATTR  
:*PMERR_INV_SCAN_START
:*PMERR_INV_PATTERN_SET_ATTR  
:*PMERR_JFILE_BUSY
:*PMERR_INV_PATTERN_SET_FONT  
:*PMERR_RAM_JNL_FILE_TOO_SMALL
:*PMERR_INV_RECT  
:Refer to the "Error Explanations" section of the ''Presentation Manager Programming Reference'' for further explanation.
:*PMERR_INV_REGION_CONTROL  
:*PMERR_INV_SCAN_START  
:*PMERR_JFILE_BUSY  
:*PMERR_RAM_JNL_FILE_TOO_SMALL  
 
:Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.  


==Remarks==
==Remarks==
This function opens the previously created journal file and turns ON the COM_RECORDING bit. Subsequent calls to this DC drop through GreAccumulateJournalFile until GreStopJournalFile is called.  
This function opens the previously created journal file and turns ON the COM_RECORDING bit. Subsequent calls to this DC drop through [[GreAccumulateJournalFile]] until [[GreStopJournalFile]] is called.
 
;Note: The COM_DRAW bit is turned OFF until GreStopJournalFile is called.
 
==Sample Code==
<PRE>
 
#define INCL_GRE_JOURNALING
#include <os2.h>
 
HDC      hdc;        /*  Device context handle. */
ULONG    hJournal;  /*  Journal file handle. */
PVOID    pInstance;  /*  Pointer to instance data. */
ULONG    lFunction;  /*  High-order WORD=flags; low-order WORD=NGreStartJournalFile. */
BOOL    fSuccess;  /*  Return codes. */


fSuccess = GreStartJournalFile(hdc, hJournal,
;Note: The COM_DRAW bit is turned OFF until GreStopJournalFile is called.
            pInstance, lFunction);
</PRE>


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

Revision as of 23:29, 17 January 2020

GreStartJournalFile starts the journaling process.

This function is supported by the graphics engine.

Syntax

GreStartJournalFile(hdc, hJournal, pInstance, lFunction)

Parameters

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

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_COORDINATE_OVERFLOW
  • PMERR_DEV_FUNC_NOT_INSTALLED
  • PMERR_EXCEEDS_MAX_SEG_LENGTH
  • PMERR_HBITMAP_BUSY
  • PMERR_HDC_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_CODEPAGE
  • PMERR_INV_COLOR_ATTR
  • PMERR_INV_COORD_SPACE
  • PMERR_INV_COORDINATE
  • PMERR_INV_DC_DATA
  • PMERR_INV_DC_TYPE
  • PMERR_INV_DRIVER_NAME
  • 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_TYPE_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_RECT
  • PMERR_INV_REGION_CONTROL
  • PMERR_INV_SCAN_START
  • PMERR_JFILE_BUSY
  • PMERR_RAM_JNL_FILE_TOO_SMALL
Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.

Remarks

This function opens the previously created journal file and turns ON the COM_RECORDING bit. Subsequent calls to this DC drop through GreAccumulateJournalFile until GreStopJournalFile is called.

Note
The COM_DRAW bit is turned OFF until GreStopJournalFile is called.
Retrieved from "https://www.edm2.com/index.php?title=GreStartJournalFile&oldid=69429"