# EssCreateLocalContext

Description

EssCreateLocalContext() creates a local API context for use in local API operations.

Syntax

    ESS_FUNC_M EssCreateLocalContext (hInstance, UserName, Password, phLocalCtx);

ESS_HINST_T | hInstance;
ESS_STR_T | UserName;
ESS_STR_T | Password;
ESS_PHCTX_T | phLocalCtx;

Parameters

hInstance | Essbase API instance handle.
UserName | Currently not used - should be NULL.
Password | Currently not used - should be NULL.
phLocalCtx | Address of variable to receive Essbase local context handle.

Return Value

If successful, a valid local context handle is returned in phLocalCtx.

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.

Access

This function requires no special privileges.

Example

See the example of EssGetLocalPath().

See Also

EssDeleteLocalContext()
EssInit()