General Status Codes
[Status Codes]

---

Detailed Description

General status codes start at 1 and continue until 999

Defines
#define	kOfxStatOK   0
	Status code indicating all was fine.
#define	kOfxStatFailed   ((int)1)
	Status error code for a failed operation.
#define	kOfxStatErrFatal   ((int)2)
	Status error code for a fatal error.
#define	kOfxStatErrUnknown   ((int)3)
	Status error code for an operation on or request for an unknown object.
#define	kOfxStatErrMissingHostFeature   ((int) 4)
	Status error code returned by plug-ins when they are missing host functionality, either an API or some optional functionality (eg: custom params).
#define	kOfxStatErrUnsupported   ((int) 5)
	Status error code for an unsupported feature/operation.
#define	kOfxStatErrExists   ((int) 6)
	Status error code for an operation attempting to create something that exists.
#define	kOfxStatErrFormat   ((int) 7)
	Status error code for an incorrect format.
#define	kOfxStatErrMemory   ((int) 8)
	Status error code indicating that something failed due to memory shortage.
#define	kOfxStatErrBadHandle   ((int) 9)
	Status error code for an operation on a bad handle.
#define	kOfxStatErrBadIndex   ((int)10)
	Status error code indicating that a given index was invalid or unavailable.
#define	kOfxStatErrValue   ((int) 11)
	Status error code indicating that something failed due an illegal value.
#define	kOfxStatReplyYes   ((int) 12)
	OfxStatus returned indicating a 'yes'.
#define	kOfxStatReplyNo   ((int) 13)
	OfxStatus returned indicating a 'no'.
#define	kOfxStatReplyDefault   ((int) 14)
	OfxStatus returned indicating that a default action should be performed.

---

Define Documentation

#define kOfxStatErrBadHandle   ((int) 9)

Status error code for an operation on a bad handle.

#define kOfxStatErrBadIndex   ((int)10)

Status error code indicating that a given index was invalid or unavailable.

#define kOfxStatErrExists   ((int) 6)

Status error code for an operation attempting to create something that exists.

#define kOfxStatErrFatal   ((int)2)

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.

#define kOfxStatErrFormat   ((int) 7)

Status error code for an incorrect format.

#define kOfxStatErrMemory   ((int) 8)

Status error code indicating that something failed due to memory shortage.

#define kOfxStatErrMissingHostFeature   ((int) 4)

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.

#define kOfxStatErrUnknown   ((int)3)

Status error code for an operation on or request for an unknown object.

#define kOfxStatErrUnsupported   ((int) 5)

Status error code for an unsupported feature/operation.

#define kOfxStatErrValue   ((int) 11)

Status error code indicating that something failed due an illegal value.

#define kOfxStatFailed   ((int)1)

Status error code for a failed operation.

#define kOfxStatOK   0

Status code indicating all was fine.

#define kOfxStatReplyDefault   ((int) 14)

OfxStatus returned indicating that a default action should be performed.

#define kOfxStatReplyNo   ((int) 13)

OfxStatus returned indicating a 'no'.

#define kOfxStatReplyYes   ((int) 12)

OfxStatus returned indicating a 'yes'.

---

Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:

1. Redistributions of the document must retain the above copyright notice and this list of conditions.
2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Automatic documentation generated by DOxygen.