dlm_FileReleaseEvent()

Releases an event for disposal or reuse.

#include "dlmfile.h"

DlmResult dlm_FileReleaseEvent
    (
        DlmFileId  id,
        DlmEvent   event
    );

dlm_FileReleaseEvent() releases an event for disposal or reuse. This function will free any memory associated with the event.

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

• dlm_ERROR_INVALID_ID
• dlm_ERROR_INVALID_PARAMETERS

dlm_FileRead()
dlm_FileReadEvents()
dlm_FileWrite()

if ((result = dlm_FileRead(id, &event)) < 0)
{
    printf("Error: Failure reading (%p): (%d) %s.\n",
                   event, result, 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);
    }
}