GreStopJournalFile

GreStopJournalFile writes the END_OF_JOURNALFILE marker into the journal file, closes the journal file, and turns OFF the COM_RECORDING bit.

This function is supported by the graphics engine.

Syntax

GreStopJournalFile(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=NGreStopJournalFile.

Return Code

rc (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_INV_DC_DATA
• PMERR_INV_HDC
• PMERR_INV_HJOURNAL
• PMERR_INV_IN_AREA
• PMERR_INV_IN_PATH
• PMERR_INV_METAFILE
• PMERR_JFILE_BUSY
• PMERR_RAM_JNL_FILE_TOO_SMALL

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

Sample Code

#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=NGreStopJournalFile. */
BOOL     rc;         /*  Return codes. */

rc = GreStopJournalFile(hdc, hJournal, pInstance,
       lFunction);