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_ThInstance;
ESS_STR_TUserName;
ESS_STR_TPassword;
ESS_PHCTX_TphLocalCtx;

Parameters

hInstanceEssbase API instance handle.
UserNameCurrently not used - should be NULL.
PasswordCurrently not used - should be NULL.
phLocalCtxAddress of variable to receive Essbase local context handle.

Return Value

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

Notes

Access

This function requires no special privileges.

Example

See the example of EssGetLocalPath().

See Also

EssDeleteLocalContext()
EssInit()