CDPL::Chem::INCHIReturnCode Namespace Reference

Provides constants that are used to describe the status of an InChI [INCHI] output or input operation. More...

Variables
CDPL_CHEM_API const int	SKIP
	Not used by the InChI C-library. More...
CDPL_CHEM_API const int	EOF_
	Specifies that no structural data were provided for the InChI generation (e.g. empty structure). More...
CDPL_CHEM_API const int	OKAY
	Specifies that the operation was successful and no warnings have been issued. More...
CDPL_CHEM_API const int	WARNING
	Specifies that the operation was successful but warnings have been issued. More...
CDPL_CHEM_API const int	ERROR
	Specifies that the operation was not successful and no InChI has been created. More...
CDPL_CHEM_API const int	FATAL
	Specifies that the operation was not successful because some severe error occurred during processing (typically a memory allocation failure). More...
CDPL_CHEM_API const int	UNKNOWN
	Specifies that the operation was not successful because of an unknown program error. More...
CDPL_CHEM_API const int	BUSY
	Specifies that a previous call to the InChI generation function has not yet returned (should never happen). More...

Detailed Description

Provides constants that are used to describe the status of an InChI [INCHI] output or input operation.

The defined constants correspond to the return values of the InChI C-API functions (see [INCHI]) that were used for the creation or decoding of InChI strings and keys.

Variable Documentation

SKIP

CDPL_CHEM_API const int CDPL::Chem::INCHIReturnCode::SKIP

extern

Not used by the InChI C-library.

EOF_

CDPL_CHEM_API const int CDPL::Chem::INCHIReturnCode::EOF_

extern

Specifies that no structural data were provided for the InChI generation (e.g. empty structure).

OKAY

CDPL_CHEM_API const int CDPL::Chem::INCHIReturnCode::OKAY

extern

Specifies that the operation was successful and no warnings have been issued.

WARNING

CDPL_CHEM_API const int CDPL::Chem::INCHIReturnCode::WARNING

extern

Specifies that the operation was successful but warnings have been issued.

ERROR

CDPL_CHEM_API const int CDPL::Chem::INCHIReturnCode::ERROR

extern

Specifies that the operation was not successful and no InChI has been created.

FATAL

CDPL_CHEM_API const int CDPL::Chem::INCHIReturnCode::FATAL

extern

Specifies that the operation was not successful because some severe error occurred during processing (typically a memory allocation failure).

UNKNOWN

CDPL_CHEM_API const int CDPL::Chem::INCHIReturnCode::UNKNOWN

extern

Specifies that the operation was not successful because of an unknown program error.

BUSY

CDPL_CHEM_API const int CDPL::Chem::INCHIReturnCode::BUSY

extern

Specifies that a previous call to the InChI generation function has not yet returned (should never happen).