# EssOtlFindAlias

Description

EssOtlFindAlias() finds a member with the specified alias name and returns a handle to the member.

Syntax

    ESS_FUNC_M EssOtlFindAlias (hOutline, pszAlias, pszAliasTable, phMember);

ESS_HOUTLINE_T | hOutline
ESS_STR_T | pszAlias
ESS_STR_T | pszAliasTable
ESS_PHMEMBER_T | phMember

Parameters

hOutline | Outline context handle.
pszAlias | Alias name to find.
pszAliasTable | Alias table to search in. Use ESS_NULL to search all alias tables. Use "Default" to search the default alias table.
phMember | Variable for the return of the member handle. ESS_NULL if the member is not found.

Return Value

Returns 0 if successful. If no member is found, *phMember is set to ESS_NULL and the call returns 0.

Notes

- Aliases used in alias combinations are also searched.

Example

    #include <essapi.h>
    #include <essotl.h>
    ESS_STS_T   sts = 0;
    ESS_OBJDEF_T  Object;
    ESS_HOUTLINE_T   hOutline;
    ESS_HMEMBER_T   hMemberAlias;
    ESS_APPNAME_T         szAppName;
    ESS_DBNAME_T          szDbName;
    ESS_OBJNAME_T         szFileName;
    memset(&Object, '\0', sizeof(Object));
    Object.hCtx = hCtx;
    Object.ObjType = ESS_OBJTYPE_OUTLINE;
    strcpy(szAppName, "Sample");
    strcpy(szDbName, "Basic");
    strcpy(szFileName, "Basic");
    Object.AppName = szAppName;
    Object.DbName = szDbName;
    Object.FileName = szFileName;
    sts = EssOtlOpenOutline(hCtx, &Object, ESS_TRUE,
          ESS_TRUE, &hOutline);
    if (!sts)
    {
       /* search all alias tables */
       sts = EssOtlFindAlias(hOutline, "Colas",
             ESS_NULL, &hMemberAlias);
    }

See Also

EssOtlGetOutlineInfo()
EssOtlGetMemberAlias()