EssSetActive
Description
EssSetActive() sets the caller's active application and database.
Syntax
ESS_FUNC_M EssSetActive (hCtx, AppName, DbName, pAccess);
ESS_HCTX_T | hCtx |
ESS_STR_T | AppName |
ESS_STR_T | DbName |
ESS_PACCESS_T | pAccess |
Parameters
hCtx | Essbase API context handle. |
AppName | Application name. |
DbName | Database name. |
pAccess | Address of variable to receive the user's access level to the selected database. See Bitmask Data Types for a list of possible values for this field.
|
Return Value
If successful, returns the user's access level to the selected
application and database in pAccess.
Notes
- If the application and database have not been loaded, this
function will load them.
- The EssAutoLogin() function can also be used to allow
a user to login and set the active application and database.
Access
This function requires no special privileges.
Example
ESS_FUNC_M
ESS_SetActive (ESS_HCTX_T hCtx)
{
ESS_FUNC_M sts = ESS_STS_NOERR;
ESS_ACCESS_T Access;
ESS_STR_T AppName;
ESS_STR_T DbName;
AppName = "Sample";
DbName = "Basic";
sts = EssSetActive (hCtx, AppName, DbName,
&Access);
return (sts);
}
See Also
EssClearActive()
EssGetActive()
EssListApplications()
EssListDatabases()
EssLogin()