EsbGetDatabaseNote

Description

EsbGetDatabaseNote() gets 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
EsbGetDatabaseNote (hCtx, AppName, DbName, DbNote, szDbNote)
ByVal hCtx     As Long
ByVal AppName  As String
ByVal DbName   As String
ByVal DbNote   As String
ByVal szDbNote As Integer

Parameters

hCtxEssbase VB API context handle.
AppNameApplication name.
DbNameDatabase name.
DbNoteBuffer to receive a database note string.
szDbNoteSize of the buffer.

Return Value

If successful, returns a database note string in DbNote.

Notes

Access

This function requires the caller to have access to the specified database.

Example

Declare Function EsbGetDatabaseNote Lib "ESBAPIW" (ByVal hCtx As Long, ByVal AppName As String, ByVal DbName As String, ByVal DbNote As String, ByVal szDbNote As Integer) As Long

Sub ESB_GetDatabaseNote ()
   Dim sts As Long
   Dim AppName As String 
   Dim DbName As String 
   Const szDbNote = 256
   Dim DbNote As String(szDbNote)

   AppName = "Sample"
   DbName = "Basic"

   '******************
   ' Get Database note 
   '******************
   sts = EsbGetDatabaseNote (hCtx, AppName,
         DbName, DbNote, szDbNote) 
End Sub 

See Also

EsbSetDatabaseNote()