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_ThInstance
ESS_STR_TServer
ESS_STR_TToken
ESS_PUSHORT_TpDbCount
ESS_PPAPPDB_TppDbList
ESS_PHCTX_TphCtx

Parameters

hInstanceEssbase API instance handle.
ServerNetwork server name string.
TokenThe token representing the username and password of an authenticated user.
pDbCountAddress of variable to receive count of accessible applications/databases.
ppDbListAddress of pointer to receive allocated array of application/databasename structures.
phCtxPointer 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

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()