Return Values

Return Value Definitions

Definition

Description

FORMATCORE_SUCCESS

Successful execution

FORMATCORE_FAILURE

Function call failed

FORMATCORE_INVALID_HANDLE

File / image handle is invalid

FORMATCORE_INVALID_ARGUMENT

Unexpected function argument ( null pointer, etc )

Remarks

In case of an error, FormatCorePlugin_GetErrorMessage is called to retrieve the error message. Plugins should save state information in the handle to make it possible to retrieve error information.