# EssExport

Description

EssExport() exports a database to an ASCII file.

Syntax

    ESS_FUNC_M EssExport (hCtx, AppName, DbName, PathName,
    Level, Columns);

ESS_HCTX_T | hCtx
ESS_STR_T | AppName
ESS_STR_T | DbName
ESS_STR_T | PathName
ESS_SHORT_T | Level
ESS_SHORT_T | Columns

Parameters

hCtx | Essbase API context handle.
AppName | Name of application to export.
DbName | Name of database to export.
PathName | Full path name of server file to contain exported information.
Level | Controls level of data to export. Should be one of: ESS_DATA_ALL - export all levels of data. ESS_DATA_LEVEL0 - only export all data from level zero blocks. ESS_DATA_INPUT - only export data from input level blocks.
Columns | Controls output of data blocks in column format (for creating rules files).

Return Value

None.

Access

This function requires the caller to have at least read access (ESS_PRIV_READ) to the database, and to have selected it as their active database using EssSetActive().

Example

    ESS_FUNC_M
    ESS_Export  (ESS_HCTX_T   hCtx)
    {
       ESS_FUNC_M       sts = ESS_STS_NOERR;
       ESS_SHORT_T     isLevel;
       ESS_STR_T       AppName;
       ESS_STR_T       DbName;
       ESS_STR_T       FileName;
       ESS_PROCSTATE_T pState;

       isLevel  = ESS_DATA_LEVEL0;
       AppName  = "Sample";
       DbName   = "Basic";
       FileName =
         "c:\\essbase\\app\\sample\\basic\\test.txt";
       sts = EssExport (hCtx, AppName, DbName,
             FileName, isLevel, ESS_FALSE);

       if (!sts)
       {
          sts = EssGetProcessState (hCtx, &pState);
          while (sts || (pState.State !=
                 ESS_STATE_DONE))
            sts = EssGetProcessState (hCtx, &pState);
       }

      return (sts);
    }

See Also

EssImport()