am_sso_init()

Initializes the data structures, allowing communication with the Session Service.

Details

am_sso_init() takes as input a properties file that contains name/value pairs, and returns status on the success or failure of the initialization. This call must be made before calling any other am_sso_* functions. See Single Sign-on Properties for more information.

Syntax

#include "am_sso.h"
AM_EXPORT am_status_t
am_sso_init(am_properties_t property_map);

Parameters

This function takes the following parameter:

property_map

Pointer to the am_properties_t structure used to initialize the Session Service.

---

Note –

See am_properties_t for more information.

---

Returns

This function returns one of the following values of the am_status_t enumeration (defined in the <am_types.h> header file):

AM_SUCCESS

If the initialization was successful.

AM_*

If any error occurs, the type of error indicated by the status value.