EsbSetDatabaseNote

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

EsbSetDatabaseNote (hCtx, AppName, DbName, DbNote)
ByVal hCtx    As Long
ByVal AppName As String
ByVal DbName  As String
ByVal DbNote  As 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 (ESB_PRIV_DBDESIGN) for the specified database.

Example

Declare Function EsbSetDatabaseNote Lib "ESBAPIN" (ByVal hCtx As Long, ByVal AppName As String, ByVal DbName As String, ByVal DbNote As String) As Long 

Sub ESB_SetDatabaseNote ()
   Dim sts As Long
   Dim AppName As String 
   Dim DbName As String 
   Dim DbNote As String   AppName = "Sample"
   DbName = "Basic"
   DbNote = "This is a test" 
   '******************
   ' Set Database note 
   '******************
   sts = EsbSetDatabaseNote (hCtx, AppName,
         DbName, DbNote) 
End Sub 

See Also