EssUnloadApplication

Stops an application on the server.

Syntax

ESS_FUNC_M  EssUnloadApplication (hCtx, AppName);
ParameterData TypeDescription

hCtx

ESS_HCTX_T

API context handle

AppName

ESS_STR_T

Name of application to load

Notes

To unload an application, the connected user must have load access to the application. An application cannot be unloaded if Essbase is restructuring a database associated with the application.

Return Value

None.

Access

This function requires the caller to have Application Load/Unload privilege (ESS_PRIV_APPLOAD) for the specified application.

Example

ESS_FUNC_M 
ESS_UnloadApplication (ESS_HCTX_T hCtx)
{
   ESS_FUNC_M    sts = ESS_STS_NOERR;
   ESS_STR_T    AppName;
   
   AppName = "Sample";
   sts = EssUnloadApplication(hCtx, AppName);
   
   return (sts);
}

See Also