# EssSendString

Description

EssSendString() sends a string of data to the active database. The string must be less than 32 Kbytes long. This function should be called after EssBeginReport(), EssBeginUpdate(), or EssBeginCalc().

Syntax

    ESS_FUNC_M  EssSendString (hCtx, String);

ESS_HCTX_T | hCtx
ESS_STR_T | String

Parameters

hCtx | Essbase API context handle.
String | Data string (must be less than 32 Kbytes in length.

Return Value

None.

Notes

- Calling this function other than after successfully executing a begin report, update or calculate function will generate an error.
- The string to be sent must be less than 32 Kbytes long.
- When you are using this function with EssBeginUpdate(), you must end the update string with a carriage return or line feed character.

Access

This function requires no special privileges.

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

EssBeginCalc()
EssBeginReport()
EssBeginUpdate()
EssGetString()