# EssEndReport

Description

EssEndReport() marks the end of a report specification being sent to the active database. This function must be called after sending the report specification (using EssSendString()) and before reading any returned data (using EssGetString()).

Syntax

    ESS_FUNC_M EssEndReport (hCtx);

ESS_HCTX_T | hCtx

Parameters

hCtx | Essbase API context handle.

Return Value

None.

Notes

- This function must be preceded by a call to EssBeginReport(), and at least one call to EssSendString().
- If the output flag is TRUE for the call to EssBeginReport() that begins the report sequence, the call to EssEndReport() must be followed by repeated calls to EssGetString() until a NULL string is returned.

Access

This function requires the caller to have read privilege (ESS_PRIV_READ) to one or more members in the active database.

Example

    ESS_FUNC_M
    ESS_Report (ESS_HCTX_T   hCtx,
                ESS_HINST_T  hInst
               )
    {
       ESS_FUNC_M      sts     = ESS_STS_NOERR;
       ESS_STR_T     rString = NULL;
       sts = EssBeginReport (hCtx,ESS_TRUE,ESS_FALSE);
       if (!sts)
          sts = EssSendString (hCtx, "<Desc Year !");
       if (!sts)
          sts = EssEndReport (hCtx);
       /**************
        * Get report *
        **************/

       if (!sts)
          sts = EssGetString (hCtx, &rString);
       while ((!sts) && (rString != NULL))
       {
              printf ("%s", rString);
              EssFree (hInst, rString);
              sts = EssGetString (hCtx, &rString);
       }
       printf ("\r\n");

       return(sts);
    }

See Also

EssBeginReport()
EssGetString()
EssSendString()