EssAutoLogin

Description

EssAutoLogin() displays a dialog box that allows the user to log in to an Essbase server, and optionally select an active application and database.

Syntax

ESS_FUNC_M EssAutoLogin (hInstance, Server, UserName,
Password, AppName, DbName, Options, pAccess, phCtx);
ESS_HINST_ThInstance
ESS_SVRNAME_TServer
ESS_USERNAME_TUserName
ESS_PASSWORD_TPassword
ESS_ APPNAME _TAppName
ESS_ DBNAME _TDbName
ESS_USHORT_TOptions
ESS_PACCESS_TpAccess
ESS_PHCTX_TphCtx

Parameters

hInstanceEssbase API instance handle
ServerNetwork server name string
UserNameUser name string
PasswordPassword string
AppNameApplication name
DbNameDatabase name
OptionsOptions flag. Values:

AUTO_NODIALOG: Attempts to log the user in without displaying the dialog, using the default settings (from the above arguments).
AUTO_NOSELECT: Allows the user to log in without selecting an application and database (lower part of the dialog is not displayed).
You can use both AUTO_NODIALOG and AUTO_NOSELECT with an OR operator (|) to log in a user without a dialog box and not select an application and database.
AUTO_NODIALOG|AUTO_NOSELECT
AUTO_DEFAULT: Allows the user to log in and select an application and database interactively in the dialog box.

pAccessAddress of variable to receive database access level.
phCtxAddress of variable to receive Essbase context handle. Set to ESS_INVALID_HCTX unless you are reusing an existing (valid) context handle to log in again.

Return Value

If successful, returns an Essbase context handle in phCtx, which can be passed as an argument in subsequent calls to other API functions. Also returns the user's access level to the selected application and database (if selected) in pAccess.

Notes

Access

Before calling this function, you must first initialize the API and obtain a valid instance handle by calling the EssInit() function.

See Also

EssInit()
EssListDatabases()
EssLogin()
EssLogout()
EssSetActive()