1.. _statusCodes:
2
3Status Codes
4============
5
6Status codes are returned by most functions in OFX suites and all
7plug-in actions to indicate the sucess or failure of the operation. All
8status codes are defined in `ofxCore.h <https://github.com/ofxa/openfx/blob/master/include/ofxCore.h>`_ and
9*#defined* to be integers.
10
11.. doxygentypedef:: OfxStatus
12
13
14Most OFX functions in host suites and all actions in a plug-in return a
15status code, where the status codes are all 32 bit integers. This
16typedef is used to label that status code.
17
18
19.. doxygendefine:: kOfxStatOK
20
21.. doxygendefine:: kOfxStatFailed
22
23.. doxygendefine:: kOfxStatErrFatal
24
25.. doxygendefine:: kOfxStatErrUnknown
26
27.. doxygendefine:: kOfxStatErrMissingHostFeature
28
29.. doxygendefine:: kOfxStatErrUnsupported
30
31.. doxygendefine:: kOfxStatErrExists
32
33.. doxygendefine:: kOfxStatErrFormat
34
35.. doxygendefine:: kOfxStatErrMemory
36
37.. doxygendefine:: kOfxStatErrBadHandle
38
39.. doxygendefine:: kOfxStatErrBadIndex
40
41.. doxygendefine:: kOfxStatErrValue
42
43.. doxygendefine:: kOfxStatReplyYes
44
45.. doxygendefine:: kOfxStatReplyNo
46
47.. doxygendefine:: kOfxStatReplyDefault
48
49
50