am_cleanup()

Cleans up any memory allocated by C SDK.

This function must be called when a caller is done with C SDK interfaces to cleanup memory allocated by the C SDK.

Syntax

#include "am_h.h"
AM_EXPORT am_status_t
am_cleanup(void);

Parameters

This function takes no parameters.

Returns

This function returns am_status_t with one of the following values:

Value

Description

AM_SUCCESS

If XML message was successfully parsed and processed.

AM_INVALID_ARGUMENT

If any input parameter is invalid.

AM_FAILURE

If any other error occurred.

Details

This should be called only once at the end of C SDK calls, after which the initialize functions am_*_init() must be called again to initialize the C SDK before using any of its interfaces.

Any properties input parameter given to the init functions am_sso_init(), am_auth_init() or am_policy_init() should be destroyed only after am_cleanup is called.