GreOpenJournalFile
Appearance
GreOpenJournalFile opens a journal file for play. The journal file must exist and must contain valid journaled calls.
This function is supported by the graphics engine.
Syntax
GreOpenJournalFile(pszFileName, flOption, cBufSize, pInstance, lFunction)
Parameters
- pszFileName (PSZ) - input
- Pointer a string containing the file name.
- flOption (ULONG) - input
- An option flag that identifies the type of journal file.
- Valid values are:
- JNL_PERM_FILE - A disk file with the name pszFileName, which was created by using GreCreateJournalFile (JNL_PERM_FILE).
- Bit 3 - A shared memory file pointed to by pszFileName and already filled with complete journal records. One way this journal file might have been created is by using GreCreateJournalFile (JNL_USERRAM_FILE) and being filled by the engine.
- cBufSize (ULONG) - input
- Size of buffer required for the file.
- pInstance (PVOID) - input
- Pointer to instance data.
- lFunction (ULONG) - input
- High-order WORD=flags; low-order WORD=NGreOpenJournalFile.
Return Code
- rc (ULONG) - returns
- Return codes.
- This function returns the journal file handle (ULONG), or if an error occurs, it returns NULL.
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_INSUFFICIENT_MEMORY
- PMERR_INV_IN_AREA
- PMERR_INV_IN_PATH
- PMERR_INV_JOURNAL_OPTION
- PMERR_RAM_JNL_FILE_TOO_SMALL
Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.