Top > Visual Basic Main API > Visual Basic Main API Functions > CreateLocalContext

EsbCreateLocalContext

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

Syntax

EsbCreateLocalContext (hInst, User, Password, phCtx)

ByVal hInst    As Long
ByVal User     As String
ByVal Password As String
      phCtx    As Long

Parameters

hInst	VB API instance handle.
User	Currently not used - should be an empty string.
Password	Currently not used - should be an empty string.
phCtx	Address of variable to receive Essbase Server 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 VB API operations (for example local file/object functions) is desired. It should be called after calling EsbInit().
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 EsbDeleteLocalContext() when the application has finished accessing local objects.

Access

This function requires no special privileges.

Example

Declare Function EsbCreateLocalContext Lib "ESBAPIN" (ByVal hInst As Long, ByVal User As String, ByVal Password As String, hCtx As Long) As Long

Sub ESB_CreateLocalContext ()
   Dim sts As Long
   Dim User As String
   Dim Password As String
   Dim hCtx As Long   '*********************
   ' Create Local Context
   '*********************
   sts = EsbCreateLocalContext (hInst, User, Password, hCtx) 
End Sub