kv_store_login()

#include <kvstore.h>

kv_error_t 
kv_store_login(kv_store_t *store,
               kv_credentials_t *creds) 

Updates the login credentials used by the store handle. Use this function under one of the two following circumstances:

  1. The application returns KV_AUTH_FAILURE. Calling this function causes the handle to attempt to re-establish the authentication to the store. The credentials used in this case must be for the handle's currently logged in user.

  2. If the handle is currently logged out due to a call to kv_store_logout(), then this function can be used to log in to the store. In that case, login credentials for any valid user can be used.

You create a credentials structure using kv_create_password_credentials().

Parameters

  • store

    The store parameter references the store handle that you want to use for authentication or reauthentication.

  • creds

    The creds parameter is the authentication credentials structure you want to use for this log in attempt.