EssArchiveBegin

Description

EssArchiveBegin() prepares the server for archiving by changing server mode to Read-Only.

Syntax

ESS_FUNC_M EssArchiveBegin (hCtx, AppName, DbName, FileName);
ESS_HCTX_ThCtx
ESS_STR_TAppName
ESS_STR_TDbName
ESS_STR_TFileName

Parameters

hCtxEssbase API context handle
AppNameName of application to archive
DbNameName of database to archive
FileNameName of file to contain archive information

Return Value

None.

Notes

Access

The caller must have at least read access (ESS_PRIV_READ) to the database, and must select it as the active database using EssSetActive().

Example

ESS_FUNC_M 
ESS_ArchiveBegin(ESS_HCTX_T hCtx)
{
   ESS_FUNC_M       sts = ESS_STS_NOERR;
   ESS_STR_T    AppName;
   ESS_STR_T    DbName;
   ESS_STR_T    FileName;
   AppName  = "Sample";
   DbName   = "Basic";
   FileName = "Test.arc";
  
   /* Begin Archive */
   sts = EssArchiveBegin(hCtx, AppName, DbName,
         FileName);
   return (sts);
}

See Also

EssArchiveEnd()
EssRestore()