EssSendString

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

Syntax

ESS_FUNC_M  EssSendString (hCtx, String);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle.
String	ESS_STR_T	Data string (must be less than 32 KB in length.

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 KB long.
When you are using this function with EssBeginUpdate(), you must end the update string with a carriage return or line feed character.

Return Value

None.

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);
}

Unicode clients using the C Main API to communicate with Unicode-enabled Essbase applications must use this function to send the UTF-8 encoded Unicode byte order mark (BOM) in the text stream. For an example, see Specifying the Byte Order Encoding.