# EssOtlGetMemberFormula

Description

EssOtlGetMemberFormula() gets the formula for the specified member.

Syntax

    ESS_FUNC_M EssOtlGetMemberFormula (hOutline, hMember, pszFormula);

ESS_HOUTLINE_T | hOutline
ESS_HMEMBER_T | hMember
ESS_PSTR_T | ppszFormula

Parameters

hOutline | Outline context handle
hMember | Member handle.
ppszFormula | Variable for the return of the member formula. This buffer is allocated by the API.

Return Value

Returns 0 if successful.

Notes

- Use EssFree() to free the formula buffer.

Example

    #include <essapi.h>
    #include <essotl.h>

    ESS_STS_T          sts = 0;
    ESS_OBJDEF_T       Object;
    ESS_HOUTLINE_T     hOutline;
    ESS_HMEMBER_T      hMember;
    ESS_STR_T          pszFormula = ESS_NULL;
    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)
    {
       sts = EssOtlFindMember(hOutline, "Variance",
             &hMember);
    }

    if (!sts  && hMember)
    {
       sts = EssOtlGetMemberFormula(hOutline,
             hMember, &pszFormula);
    }
    if (pszFormula)
    {
       EssFree(hInst, pszFormula);
    }

See Also

EssFree()
EssOtlDeleteMemberFormula()
EssOtlGetMemberLastFormula()
EssOtlOpenOutline()
EssOtlOpenOutlineQuery()
EssOtlSetMemberFormula()