Status.h File Reference

Declares the stable status values returned by the apoCHARMM C ABI. More...

Typedefs
typedef enum apo_status	apo_status
	Identifies success or a categorized failure returned by the C ABI.

Enumerations
enum	apo_status {   APO_STATUS_OK = 0 , APO_STATUS_INVALID_ARGUMENT = 1 , APO_STATUS_RUNTIME_ERROR = 2 , APO_STATUS_CUDA_ERROR = 3 ,   APO_STATUS_NOT_INITIALIZED = 4 , APO_STATUS_NOT_IMPLEMENTED = 5 }
	Identifies success or a categorized failure returned by the C ABI. More...

Detailed Description

Declares the stable status values returned by the apoCHARMM C ABI.

Typedef Documentation

apo_status

typedef enum apo_status apo_status

Identifies success or a categorized failure returned by the C ABI.

The explicit numeric values are part of the public C ABI. After a nonzero status, call apo_last_error on the same thread before another status-returning apoCHARMM C API call clears or replaces the diagnostic.

Note

Every declared nonzero value represents failure.

See also

ApoCharmmErrorCode

Enumeration Type Documentation

apo_status

enum apo_status

Identifies success or a categorized failure returned by the C ABI.

The explicit numeric values are part of the public C ABI. After a nonzero status, call apo_last_error on the same thread before another status-returning apoCHARMM C API call clears or replaces the diagnostic.

Note

Every declared nonzero value represents failure.

See also

ApoCharmmErrorCode

Enumerator
APO_STATUS_OK	Indicates that the operation completed successfully.
APO_STATUS_INVALID_ARGUMENT	Indicates that an argument, pointer, size, or value was rejected.
APO_STATUS_RUNTIME_ERROR	Indicates an uncategorized runtime or translated exception failure.
APO_STATUS_CUDA_ERROR	Indicates that a CUDA operation failed.
APO_STATUS_NOT_INITIALIZED	Indicates that required native state has not been initialized.
APO_STATUS_NOT_IMPLEMENTED	Indicates that a recognized operation is not implemented.