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

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle
AppName	ESS_STR_T	Application name
DbName	ESS_STR_T	Database name
DbNote	ESS_STR_T	Pointer to database note string

Notes

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

Return Value

None.

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