dlm_FileRead()

Reads an event from the file.

#include "dlmfile.h"

DlmResult dlm_FileRead
    (
        DlmFileId   id,
        DlmEvent *  eventOut
    );

dlm_FileRead() reads an event from the file. Events read must eventually be released back to the file session by calling dlm_FileReleaseEvent().

If successful, dlm_FileRead() returns a non-negative value. Otherwise, it returns a negative value indicating the reason it failed. Possible unsuccessful return values are:

• dlm_ERROR_END_OF_FILE
• dlm_ERROR_FAILURE_READING_FILE
• dlm_ERROR_INVALID_COMMAND
• dlm_ERROR_INVALID_FILE
• dlm_ERROR_INVALID_ID
• dlm_ERROR_INVALID_PARAMETERS
• dlm_ERROR_OUT_OF_MEMORY

dlm_FileReadEvents()
dlm_FileReleaseEvent()
dlm_FileWrite()

if ((result = dlm_FileRead(id, &event)) < 0)
{
    printf("Error: Failure reading %s.\n", dlm_ErrorMessage(result));
}
else
{
    /* do something */

    if ((result = dlm_FileReleaseEvent(id, event)) < 0)
    {
        printf("Error: Failure releasing event (%p): (%d) %s.\n",
                       event, result, dlm_ErrorMessage(result));
    }
    else
    {
        printf("Event released.\n");
    }
}