EsbClearAliases
Description
EsbClearAliases() permanently removes all alias tables
for the active database.
Syntax
EsbClearAliases (hCtx)
ByVal hCtx As Long
Parameters
hCtx | Essbase VB API context handle.
|
Return Value
None.
Notes
- "Default" or currently active alias table can not
be removed.
- Make sure that no one else is using the same database as the
one you try to clear alias tables from by calling EsbListConnections().
- Use EsbSetAlias() to set an active alias to "default"
prior to using this VB API function.
Access
This function requires the caller to have access to the database,
and to have selected it as their active database using EsbSetActive().
Example
Declare Function EsbClearAliases Lib "ESBAPIW" (ByVal hCtx As Long) As Long
Sub ESB_ClearAliases ()
Dim sts As Long
'***************
' Remove Aliases
'***************
sts = EsbClearAliases (hCtx)
End Sub
See Also
EsbListAliases()
EsbRemoveAlias()
EsbSetAlias()
EsbListConnections()
EsbSetActive()