# EssSetDatabaseNote

Description

EssSetDatabaseNote() sets a database's note-of-the-day message. This message may be used to display useful information about the database (whether data has been loaded, when it was last calculated, etc.) to users before they connect to the database.

Syntax

    ESS_FUNC_M  EssSetDatabaseNote (hCtx, AppName, DbName, DbNote);

ESS_HCTX_T | hCtx
ESS_STR_T | AppName
ESS_STR_T | DbName
ESS_STR_T | DbNote

Parameters

hCtx | Essbase API context handle
AppName | Application name
DbName | Database name
DbNote | Pointer to database note string

Return Value

None.

Notes

- The database note string must be less than 64 Kbytes in length.

Access

This function requires the caller to have database Design privilege (ESS_PRIV_DBDESIGN) for the specified database.

Example

    ESS_FUNC_M
    ESS_SetDatabaseNote (ESS_HCTX_T hCtx)
    {
       ESS_FUNC_M      sts = ESS_STS_NOERR;
       ESS_STR_T      AppName;
       ESS_STR_T      DbName;
       ESS_STR_T      DbNote;

       AppName = "Sample";
       DbName  = "Basic";
       DbNote  = "This is a test";

       sts = EssSetDatabaseNote(hCtx, AppName, DbName,
             DbNote);

       return (sts);
    }

See Also

EssGetDatabaseNote()