データベースの最新情報に関するメッセージを取得します。
構文
ESS_FUNC_M EssGetDatabaseNote (
hCtx, AppName, DbName, pDbNote
);
パラメータ | データ型 | 説明 |
---|---|---|
hCtx |
ESS_HCTX_T |
APIコンテキスト・ハンドル。 |
AppName |
ESS_STR_T |
アプリケーション名。 |
DbName |
ESS_STR_T |
データベース名。 |
pDbNote |
ESS_PSTR_T |
割り当てられたデータベース・ノート文字列を受け取るポインタのアドレス。 |
備考
最新情報に関するメッセージを使用して、ユーザーがデータベースに接続する前に、データベースに関する有用な情報(データがロードされているかどうか、データが最後に計算されたのはいつかなど)を表示できます。
データベース・ノート文字列の長さは常に、64KB未満である必要があります。
データベースのノートは、EssSetDatabaseNoteによって設定されます。
pDbNoteに対して割り当てられたメモリーは、EssFreeを使用して解放する必要があります。
戻り値
正常終了の場合、割り当てられたデータベース・ノート文字列へのポインタがpDbNoteに戻されます。
アクセス
この関数を使用するには、呼出し元が少なくとも指定したデータベースに対する読取りアクセス権(ESS_PRIV_READ)を持っている必要があります。
関連トピック