This graph shows which files directly or indirectly include this file:

Classes
struct	KIM_SupportStatus
	An Extensible Enumeration for the SupportStatus's supported by the KIM API. More...

Typedefs
typedef struct KIM_SupportStatus	KIM_SupportStatus
	Convenience typedef. More...

Functions
KIM_SupportStatus	KIM_SupportStatus_FromString (char const *const str)
	Create a SupportStatus object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated. More...

int	KIM_SupportStatus_Known (KIM_SupportStatus const supportStatus)
	Determines if the object is a quantity known to the KIM API. More...

int	KIM_SupportStatus_Equal (KIM_SupportStatus const lhs, KIM_SupportStatus const rhs)
	Compares SupportStatus objects for equality. More...

int	KIM_SupportStatus_NotEqual (KIM_SupportStatus const lhs, KIM_SupportStatus const rhs)
	Compares SupportStatus objects for inequality. More...

char const *	KIM_SupportStatus_ToString (KIM_SupportStatus const supportStatus)
	Converts the object to a string. More...

void	KIM_SUPPORT_STATUS_GetNumberOfSupportStatuses (int *const numberOfSupportStatuses)
	Get the number of standard SupportStatus's defined by the KIM API. More...

int	KIM_SUPPORT_STATUS_GetSupportStatus (int const index, KIM_SupportStatus *const supportStatus)
	Get the identity of each defined standard SupportStatus. More...

Variables
KIM_SupportStatus const	KIM_SUPPORT_STATUS_requiredByAPI
	The standard `requiredByAPI` status. More...

KIM_SupportStatus const	KIM_SUPPORT_STATUS_notSupported
	The standard `notSupported` status. More...

KIM_SupportStatus const	KIM_SUPPORT_STATUS_required
	The standard `required` status. More...

KIM_SupportStatus const	KIM_SUPPORT_STATUS_optional
	The standard `optional` status. More...

Typedef Documentation

◆ KIM_SupportStatus

typedef struct KIM_SupportStatus KIM_SupportStatus

Convenience typedef.

Since: 2.0

Definition at line 60 of file KIM_SupportStatus.h.

Function Documentation

◆ KIM_SUPPORT_STATUS_GetNumberOfSupportStatuses()

void KIM_SUPPORT_STATUS_GetNumberOfSupportStatuses ( int *const numberOfSupportStatuses )

Get the number of standard SupportStatus's defined by the KIM API.

See also: KIM::SUPPORT_STATUS::GetNumberOfSupportStatuses, kim_support_status_module::kim_get_number_of_support_statuses

Since: 2.0

◆ KIM_SUPPORT_STATUS_GetSupportStatus()

int KIM_SUPPORT_STATUS_GetSupportStatus	(	int const	index,
		KIM_SupportStatus *const	supportStatus
	)

Get the identity of each defined standard SupportStatus.

See also: KIM::SUPPORT_STATUS::GetSupportStatus, kim_support_status_module::kim_get_support_status

Since: 2.0

◆ KIM_SupportStatus_Equal()

int KIM_SupportStatus_Equal	(	KIM_SupportStatus const	lhs,
		KIM_SupportStatus const	rhs
	)

Compares SupportStatus objects for equality.

See also: KIM::SupportStatus::operator==(), kim_support_status_module::operator(.eq.)

Since: 2.0

◆ KIM_SupportStatus_FromString()

KIM_SupportStatus KIM_SupportStatus_FromString ( char const *const str )

Create a SupportStatus object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated.

See also: KIM::SupportStatus::SupportStatus(std::string const &), kim_support_status_module::kim_from_string

Since: 2.0

◆ KIM_SupportStatus_Known()

int KIM_SupportStatus_Known ( KIM_SupportStatus const supportStatus )

Determines if the object is a quantity known to the KIM API.

See also: KIM::SupportStatus::Known, kim_support_status_module::kim_known

Since: 2.0

◆ KIM_SupportStatus_NotEqual()

int KIM_SupportStatus_NotEqual	(	KIM_SupportStatus const	lhs,
		KIM_SupportStatus const	rhs
	)

Compares SupportStatus objects for inequality.

See also: KIM::SupportStatus::operator!=(), kim_support_status_module::operator(.ne.)

Since: 2.0

◆ KIM_SupportStatus_ToString()

char const* KIM_SupportStatus_ToString ( KIM_SupportStatus const supportStatus )

Converts the object to a string.

See also: KIM::SupportStatus::ToString, kim_support_status_module::kim_to_string

Since: 2.0

Variable Documentation

◆ KIM_SUPPORT_STATUS_notSupported

KIM_SupportStatus const KIM_SUPPORT_STATUS_notSupported

The standard notSupported status.

See also: KIM::SUPPORT_STATUS::notSupported, kim_support_status_module::kim_support_status_not_supported

Since: 2.0

◆ KIM_SUPPORT_STATUS_optional

KIM_SupportStatus const KIM_SUPPORT_STATUS_optional

The standard optional status.

See also: KIM::SUPPORT_STATUS::optional, kim_support_status_module::kim_support_status_optional

Since: 2.0

◆ KIM_SUPPORT_STATUS_required

KIM_SupportStatus const KIM_SUPPORT_STATUS_required

The standard required status.

See also: KIM::SUPPORT_STATUS::required, kim_support_status_module::kim_support_status_required

Since: 2.0

◆ KIM_SUPPORT_STATUS_requiredByAPI

KIM_SupportStatus const KIM_SUPPORT_STATUS_requiredByAPI

The standard requiredByAPI status.

See also: KIM::SUPPORT_STATUS::requiredByAPI, kim_support_status_module::kim_support_status_required_by_api

Since: 2.0

Classes

Typedefs

Functions

Variables