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

Parameter	Data Type	Description
hInstance	ESS_HINST_T	API instance handle
Server	ESS_SVRNAME_T	Network server name string The server name can be expressed as a URL representing the APS servlet endpoint with the Essbase failover cluster name; for example: http://myhost:13080/aps/Essbase?clustername=Essbase-Cluster1 For secure mode (SSL), the URL syntax is http[s]://host:port/aps/Essbase?ClusterName=logicalName&SecureMODE=yesORno For example, https://myhost:13080/aps/Essbase?clustername=Essbase-Cluster1&SecureMODE=Yes
UserName	ESS_USERNAME_T	User name string
Password	ESS_PASSWORD_T	Password string
AppName	ESS_ APPNAME _T	Application name
DbName	ESS_ DBNAME _T	Database name
Options	ESS_USHORT_T	Options 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—Enables the user to log in and select an application and database interactively in the dialog box.
pAccess	ESS_PACCESS_T	Address of variable to receive database access level.
phCtx	ESS_PHCTX_T	Address 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.

Notes

The dialog box is automatically managed by the function, and provides features in the login dialog to change the user password, display the database note message, etc., and so provides a standardized and powerful login screen for all applications using the API.
Use this function instead of the EssLogin function if you are programming in a Windows environment.
The function should be called after executing a successful call to EssInit, and prior to making any other API calls which require a context handle argument.
This function is supported only in Windows environments. It is not supported in UNIX environments.
The string arguments Server, UserName, Password, AppName or DbName may optionally be NULL. If any of them are not NULL, the buffers they point to are updated when the function returns the actual values selected by the user from the dialog box. If any of the passed in arguments point to valid strings, they will be used as the default displayed values in the dialog. The buffers for these arguments must be large enough to contain any possible return value, not just the values passed in.
If the login is successful, the server and user names are automatically stored (in the file ESSBASE.INI) and are used as the defaults the next time this function is called (unless those arguments are specified in subsequent calls). The names of all servers which have been successfully connected to are also stored and displayed.
The auto login dialog box is a child window of the current active window (the window that has the focus). Therefore avoid destroying the active window or changing focus while the auto login dialog is displayed.
This function returns a value of ESS_STS_CANCEL if the user presses the Cancel button or the Esc key in the dialog box.
In Windows environments, if the end user clicks the Help button, the Essbase System Login help topic shipped with the Oracle Essbase Spreadsheet Add-in User's Guide online help is opened. You can redirect the Help button to point to a different help file by specifying a different help file name in the ESS_INIT_T structure.

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.

Access

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