データベースの最新情報に関するメッセージを設定します。このメッセージを使用して、ユーザーがデータベースに接続する前に、データベースに関する有用な情報(データがロードされているかどうか、データが最後に計算されたのはいつかなど)を表示できます。
構文
EsbSetDatabaseNote
(
hCtx, AppName, DbName, DbNote
)
ByVal
hCtx
As Long
ByVal
AppName
As String
ByVal
DbName
As String
ByVal
DbNote
As String
| パラメータ | 説明 |
|---|---|
hCtx |
VB APIコンテキスト・ハンドル。 |
AppName |
アプリケーション名。 |
DbName |
データベース名。 |
DbNote |
データベース・ノート文字列へのポインタ。 |
備考
データベース・ノート文字列の長さは、64KB未満である必要があります。
戻り値
なし。
アクセス
この関数を使用するには、指定したデータベースに対して、呼出し元がデータベース・デザイン権限(ESB_PRIV_DBDESIGN)を持っている必要があります。
例
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
関連トピック