# EssGetLocationAliasList

Description

EssGetLocationAliasList() returns a list of all currently-defined location aliases, together with lists of the host names, application names, database names and user names to which the location aliases are mapped.

Syntax

ESS_FUNC_M EssGetLocationAliasList (hCtx, pusListCnt, ppAliasNames, ppHostNames, ppAppNames, ppDbNames, ppUserNames);

ESS_HCTX_T | hCtx;
ESS_PUSHORT_T | pusListCnt;
ESS_PSTR_T * | ppAliasNames;
ESS_PSTR_T * | ppHostNames;
ESS_PSTR_T * | ppAppNames;
ESS_PSTR_T * | ppDbNames;
ESS_PSTR_T * | ppUserNames;

Parameters

hCtx | Essbase API context handle
pusListCnt | Number of location aliases returned
ppAliasNames | Location alias name buffer
ppHostNames | Host name buffer
ppAppNames | Application name buffer
ppDbNames | Database name buffer
ppUserNames | User login name buffer

Return Value

Notes

- hCtx is the only input parameter.
- pusListCnt, ppAliasNames, ppHostNames, ppAppNames, ppDbNames and ppUserNames are output parameters; that is, values returned.
- After you call this function, you must call EssFree() to free the memory used by the returned lists.

Access

Example

See Also

EssCreateLocationAlias()
EssDeleteLocationAlias()