Status Codes
Status codes are returned by most functions in OFX suites and all plug-in actions to indicate the success or failure of the operation. All status codes are defined in ofxCore.h and #defined to be integers.
-
typedef int OfxStatus
OFX status return type.
Most OFX functions in host suites and all actions in a plug-in return a status code, where the status codes are all 32 bit integers. This typedef is used to label that status code.
-
kOfxStatOK
Status code indicating all was fine.
-
kOfxStatFailed
Status error code for a failed operation.
-
kOfxStatErrFatal
Status error code for a fatal error.
Only returned in the case where the plug-in or host cannot continue to function and needs to be restarted.
-
kOfxStatErrUnknown
Status error code for an operation on or request for an unknown object.
-
kOfxStatErrMissingHostFeature
Status error code returned by plug-ins when they are missing host functionality, either an API or some optional functionality (eg: custom params).
Plug-Ins returning this should post an appropriate error message stating what they are missing.
-
kOfxStatErrUnsupported
Status error code for an unsupported feature/operation.
-
kOfxStatErrExists
Status error code for an operation attempting to create something that exists.
-
kOfxStatErrFormat
Status error code for an incorrect format.
-
kOfxStatErrMemory
Status error code indicating that something failed due to memory shortage.
-
kOfxStatErrBadHandle
Status error code for an operation on a bad handle.
-
kOfxStatErrBadIndex
Status error code indicating that a given index was invalid or unavailable.
-
kOfxStatErrValue
Status error code indicating that something failed due an illegal value.
-
kOfxStatReplyYes
OfxStatus returned indicating a ‘yes’.
-
kOfxStatReplyNo
OfxStatus returned indicating a ‘no’.
-
kOfxStatReplyDefault
OfxStatus returned indicating that a default action should be performed.
Status codes for GPU renders:
These are defined in ofxGPURender.h
.
-
kOfxStatGPUOutOfMemory
GPU render ran out of memory.
-
kOfxStatGLOutOfMemory
OpenGL render ran out of memory (same as
kOfxStatGPUOutOfMemory
)
-
kOfxStatGPURenderFailed
GPU render failed in a non-memory-related way.
-
kOfxStatGLRenderFailed
OpenGL render failed in a non-memory-related way (same as
kOfxStatGPURenderFailed
)