EssLoginEx
Description
EssLoginEx() logs a user in to an Essbase server using a user authentication token rather than a username and password.
This function
should normally be called after executing a successful call to
EssInit(), and prior to making any other API calls which
require a context handle argument.
Syntax
ESS_FUNC_M EssLoginEx (hInstance, Server, Token, pDbCount, ppDbList, phCtx);
ESS_HINST_T | hInstance |
ESS_STR_T | Server |
ESS_STR_T | Token |
ESS_PUSHORT_T | pDbCount |
ESS_PPAPPDB_T | ppDbList |
ESS_PHCTX_T | phCtx |
Parameters
hInstance | Essbase API instance handle.
|
Server | Network server name string. |
Token | The token representing the username and password of an authenticated user. |
pDbCount | Address of variable to receive count of accessible applications/databases.
|
ppDbList | Address of pointer to receive allocated array of application/databasename structures.
|
phCtx | Pointer to an Essbase context handle.
|
Return Value
If successful, returns an Essbase context handle in phCtx,
which can be used as an argument in subsequent calls to other
API functions. Also returns a count of databases accessible to
the specified user in pCount, and a list of accessible
applications and databases in ppDbList.
Notes
- If this function fails, the corresponding EssLogin() function is automatically called in order to try to verify a username and password for the user.
- Memory allocated for ppDbList must be freed using EssFree().
Access
Before calling this function, you must first initialize the API
and obtain a valid instance handle by calling EssInit().
See Also
EssLogin()
EssAutoLogin()
EssInit()
EssListDatabases
EssLogout()
EssSetActive()