ikm_retval.h File Reference

Enumerations
enum	ikm_retval {   IKM_OK = 0,   IKM_ENULLPTR = -1001,   IKM_ENOMEM = -1002,   IKM_ENOTINIT = -1003,   IKM_EINVBUFSIZE = -1004,   IKM_EBADVALUE = -1005,   IKM_EOUTOFRANGE = -1006,   IKM_EVALUENOTSUPP = -1007,   IKM_EINVOBJECT = -1008,   IKM_EINVCALLBACKS = -1009,   IKM_ENOTREGISTERED = -1010,   IKM_EINVDATA = -1011,   IKM_EINVPTR = -1012,   IKM_EPTROVERLAP = -1013,   IKM_EINVALGOSTATE = -2001,   IKM_EINVHASHALGO = -2002,   IKM_EINVPUBLICKEY = -3001,   IKM_EINVPRIVATEKEY = -3002,   IKM_EKEYPAIRMISMATCH = -3004,   IKM_EINVSIGNATURE = -3006,   IKM_EKEYDEPLETED = -3007,   IKM_ENOTSEEDED = -4001,   IKM_ERESEED = -4002,   IKM_EIOFAILURE = -7001,   IKM_EINVFILEPATH = -7002 }

Functions
IQR_API const char *	ikm_StrError (ikm_retval ret)

Enumeration Type Documentation

enum ikm_retval

Enumerator
IKM_OK	Success, function completed successfully.
IKM_ENULLPTR	A NULL pointer was passed in where a valid pointer was expected.
IKM_ENOMEM	Memory allocation failed.
IKM_ENOTINIT	The specified structure is not initialized.
IKM_EINVBUFSIZE	The provided buffer has an invalid size.
IKM_EBADVALUE	The parameter value is not valid.
IKM_EOUTOFRANGE	The parameter value is out of range.
IKM_EVALUENOTSUPP	The parameter value is valid but not supported.
IKM_EINVOBJECT	The object is invalid.
IKM_EINVCALLBACKS	The provided callback pointers are invalid.
IKM_ENOTREGISTERED	Callbacks to an algorithm were not registered prior to use.
IKM_EINVDATA	The provided data is invalid.
IKM_EINVPTR	Output pointer parameters must be initialized to NULL prior to function call.
IKM_EPTROVERLAP	Input and output pointers must not be overlapping buffers.
IKM_EINVALGOSTATE	The algorithm state is invalid.
IKM_EINVHASHALGO	The provided hashing algorithm is not valid for this key type.
IKM_EINVPUBLICKEY	The public key is invalid.
IKM_EINVPRIVATEKEY	The private key is invalid.
IKM_EKEYPAIRMISMATCH	The public key is not derived from the private key.
IKM_EINVSIGNATURE	The signature of the message is invalid.
IKM_EKEYDEPLETED	The key cannot be used to create more signatures.
IKM_ENOTSEEDED	The Random Number Generator has not been seeded.
IKM_ERESEED	The Random Number Generator must be reseeded.
IKM_EIOFAILURE	The IO operation failed (query errno or GetLastError() for specific error code).
IKM_EINVFILEPATH	File path or file name is invalid.

Function Documentation

IQR_API const char* ikm_StrError

(

ikm_retval

ret

)

Convert an ikm_retval error code into an English string.

Note

Not suitable for use in programs that need internationalization.

Parameters

[in]

ret

An IKM_* error value.

Returns

A pointer to a string describing the error value, or a pointer to a string indicating an unknown error value.

Detailed Description

ISARA Radiate Key State Manager's return values.

Copyright

Copyright 2015-2017, ISARA Corporation, All Rights Reserved.

License

The code and other content set out herein is not in the public domain, is considered a trade secret and is confidential to ISARA Corporation. Use, reproduction or distribution, in whole or in part, of such code or other content is strictly prohibited except by express written permission of ISARA Corporation. Please contact ISARA Corporation at info@.nosp@m.isar.nosp@m.a.com for more information.