# EsbSetCalcList

Description

EsbSetCalcList() sets the list of calc scripts objects which are accessible to a user.

Syntax

    EsbSetCalcList (hCtx, User, AppName, DbName, isAllCalcs, CalcList, Items)

    ByVal hCtx       As Long
    ByVal User       As String
    ByVal AppName    As String
    ByVal DbName     As String
    ByVal isAllCalcs As Integer
    ByVal CalcList   As String
    ByVal Items      As Integer

Parameters

hCtx | Essbase VB API context handle.
User | User name.
AppName | Application name.
DbName | Database name. If an empty string, uses application sub-directory
isAllCalcs | Allow all calcs flag. If TRUE, the user can access all calc scripts, otherwise, they can only access those specified in the CalcList argument.
CalcList | String of calc script object names (CR, EOL delimited), the string must be less than 64 KBytes in length
Items | Items of the number of accessible calc script objects in the CalcList string.

Return Value

None.

Notes

- If the AllCalcs flag is set to TRUE, the Items and pCalcList arguments will be ignored.
- In order to access any calc script objects, the user must have at least calculate access to the appropriate database.

Access

This function requires the caller to have Database Design privilege (ESB_PRIV_DBDESIGN) for the specified database.

Example

    Declare Function EsbSetCalcList Lib "ESBAPIW" (ByVal hCtx As Long, ByVal User As String, ByVal AppName As String, ByVal DbName As String, ByVal isAllCalcs As Integer, ByVal CalcList As String, ByVal Items As Integer) As Long

    Sub EsbSetCalcList ()
       Dim sts As Long
       Dim Items As Integer
       Dim User As String
       Dim AppName As String
       Dim DbName As String
       Dim AllCalcs As Integer
       Dim CalcList As String

       User = "Joseph"
       AppName = "Sample"
       DbName = "Basic"
       AllCalcs = ESB_NO

       '******************************
       ' Initialize CalcList and Items
       '******************************
    .
    .

       '**************
       ' Set Calc list
       '**************
       sts = EsbSetCalcList (hCtx, User, AppName, DbName, AllCalcs, CalcList,
             Items)
    End Sub

See Also

EsbGetCalcList()
EsbListObjects()
EsbListUsers()