Typedefs
typedef struct iqr_Context_struct	iqr_Context

Functions
IQR_API iqr_retval	iqr_CreateContext (iqr_Context **context)

IQR_API_UNENFORCED_RETURN iqr_retval	iqr_DestroyContext (iqr_Context **context)

Typedef Documentation

§ iqr_Context

typedef struct iqr_Context_struct iqr_Context

The Context object.

Function Documentation

§ iqr_CreateContext()

IQR_API iqr_retval iqr_CreateContext ( iqr_Context ** context )

Create and initialize a Context object.

The context parameter must be initialized to NULL prior to calling this function. Otherwise, IQR_EINVPTR will be returned.

The caller must free the context using iqr_DestroyContext().

Parameters

[out] context Address of a context pointer.

Returns: IQR_OK on success, or a value from iqr_retval.h when an error occurs.

§ iqr_DestroyContext()

IQR_API_UNENFORCED_RETURN iqr_retval iqr_DestroyContext ( iqr_Context ** context )

Clear and deallocate a Context object.

context will be set to NULL prior to returning.

Parameters

[in,out] context Context pointer.

Returns: IQR_OK on success, or a value from iqr_retval.h when an error occurs.

Detailed Description

ISARA Toolkit's Context object.

Many of the APIs in ISARA's toolkit require a Context object when creating a new object. It stores information about the Toolkit library itself, and keeps track of the registered implementations for SHA-2, SHA-3, and a Random Number Generator.

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.