am_auth_login()

Starts the login process given the index type and its value.

Syntax

#include "am_auth.h"
AM_EXPORT am_status_t
am_auth_login(am_auth_context_t auth_ctx, am_auth_index_t auth_idx,
          const char *value);

Parameters

This function takes the following parameters:

auth_ctx

Handle of the auth context.

auth_idx

Index type to be used to initiate the login process.

value

Value corresponding to the index type.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS

If the login process was successfully completed.

AM_INVALID_ARGUMENT

If the auth_ctx or value parameter is NULL.

AM_FEATURE_UNSUPPORTED

If the auth_idx parameter is invalid.