Creates a local API context for use in local API operations.
Syntax
ESS_FUNC_M EssCreateLocalContext (hInstance, UserName, Password, phLocalCtx);
| Parameter | Data Type | Description |
|---|---|---|
hInstance; | ESS_HINST_T | API instance handle. |
UserName; | ESS_STR_T | Currently not used - should be NULL. |
Password; | ESS_STR_T | Currently not used - should be NULL. |
phLocalCtx; | ESS_PHCTX_T | Address of variable to receive Essbase local context handle. |
Notes
This function must be called if access to local API operations (for example local file/object functions) is desired. It should be called after calling EssInit().
It is only necessary to call the function once per client application - the context handle can be used for all local API operations.
You should call EssDeleteLocalContext() when the application has finished accessing local objects.
Return Value
If successful, a valid local context handle is returned in phLocalCtx.
Access
This function requires no special privileges.
Example
See the example of EssGetLocalPath.
See Also