Gets a database's note-of-the-day message.
Syntax
ESS_FUNC_M EssGetDatabaseNote (hCtx, AppName, DbName, pDbNote);
| Parameter | Data Type | Description |
|---|---|---|
hCtx | ESS_HCTX_T | API context handle. |
AppName | ESS_STR_T | Application name. |
DbName | ESS_STR_T | Database name. |
pDbNote | ESS_PSTR_T | Address of pointer to receive allocated database note string. |
Notes
The note-of-the-day 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.
The database note string will always be less than 64 KB in length.
The database's note is set by EssSetDatabaseNote().
The memory allocated for pDbNote should be freed using EssFree().
Return Value
If successful, returns a pointer to an allocated database note string in pDbNote.
Access
This function requires the caller to have at least read access (ESS_PRIV_READ) to the specified database.
See Also