EssSetFilterList
Description
EssSetFilterList() Sets the list of groups or users that are assigned to a filter.
The count parameter controls the number of groups or users assigned to
the filter. A count of zero will remove all the groups or users from the list.
Syntax
ESS_FUNC_M EssSetFilterList (hCtx, AppName, DbName, FilterName, Count, pUserList);
ESS_HCTX_T | hCtx |
ESS_STR_T | AppName |
ESS_STR_T | DbName |
ESS_STR_T | FilterName |
ESS_USHORT_T | Count |
ESS_PUSERNAME_T | pUserList |
Parameters
hCtx | Essbase API context handle |
AppName | Application name |
DbName | Database name |
FilterName | Filter name |
Count | Count of groups or users assigned this filter
|
pUserList | Pointer to array of user names
|
Return Value
None.
Access
This function requires the caller to have database Design privilege
(ESS_PRIV_DBDESIGN) for the specified database.
Example
ESS_FUNC_M
ESS_SetFilterList (ESS_HCTX_T hCtx)
{
ESS_FUNC_M sts = ESS_STS_NOERR;
ESS_STR_T AppName;
ESS_STR_T DbName;
ESS_STR_T FilterName;
ESS_USHORT_T Count = 0;
ESS_USERNAME_T UserList[2];
AppName = "Sample";
DbName = "Basic";
FilterName = "Test";
strcpy(UserList[0],"Jim Smith");
strcpy(UserList[1],"Newuser");
Count = 2;
sts = EssSetFilterList(hCtx, AppName, DbName,
FilterName, Count, UserList);
return (sts);
}
See Also
EssGetFilterList()
EssListFilters()
EssSetFilter()