EsbGetDatabaseNote

データベースの最新情報に関するメッセージを取得します。このメッセージを使用して、ユーザーがデータベースに接続する前に、データベースに関する有用な情報(データがロードされているかどうか、データが最後に計算されたのはいつかなど)を表示できます。

構文

            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

パラメータ	説明
hCtx	VB APIコンテキスト・ハンドル。
AppName	アプリケーション名。
DbName	データベース名。
DbNote	データベース・ノート文字列を受け取るバッファ。
szDbNote	バッファのサイズ。

備考

データベース・ノート文字列の長さは常に、64KB未満である必要があります。
アプリケーションまたはデータベースの名前の長さがバッファのサイズより大きい場合、名前は切り捨てられます。
データベースのメッセージは、EsbSetDatabaseNote()を使用して設定します。

戻り値

正常終了の場合は、データベースのメッセージ文字列がDbNoteに戻されます。

アクセス

この関数を使用するには、呼出し元は指定したデータベースに対してアクセス権を持っている必要があります。

例

         Declare Function EsbGetDatabaseNote Lib "ESBAPIN" (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