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);
| Parameter | Data Type | Description |
|---|---|---|
hCtx; | ESS_HCTX_T | API context handle |
pusListCnt; | ESS_PUSHORT_T | Number of location aliases returned |
ppAliasNames; | ESS_PSTR_T * | Location alias name buffer |
ppHostNames; | ESS_PSTR_T * | Host name buffer |
ppAppNames; | ESS_PSTR_T * | Application name buffer |
ppDbNames; | ESS_PSTR_T * | Database name buffer |
ppUserNames; | ESS_PSTR_T * | User login name buffer |
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.
See Also