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