EssGetDatabaseNote

Description

EssGetDatabaseNote() gets a database's note-of-the-day message.

Syntax
ESS_FUNC_M EssGetDatabaseNote (hCtx, AppName, DbName, pDbNote);
ESS_HCTX_ThCtx
ESS_STR_TAppName
ESS_STR_TDbName
ESS_PSTR_TpDbNote

Parameters

hCtxEssbase API context handle.
AppNameApplication name.
DbNameDatabase name.
pDbNoteAddress of pointer to receive allocated database note string.

Return Value

If successful, returns a pointer to an allocated database note string in pDbNote.

Notes

Access

This function requires the caller to have at least read access (ESS_PRIV_READ) to the specified database.

See Also

EssSetDatabaseNote()