EssSetDatabaseNote

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

構文

            ESS_FUNC_M  EssSetDatabaseNote (
            hCtx, AppName, DbName, DbNote
            );

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	APIコンテキスト・ハンドル。
AppName	ESS_STR_T	アプリケーション名。
DbName	ESS_STR_T	データベース名。
DbNote	ESS_STR_T	データベース・ノート文字列へのポインタ。

備考

データベース・ノート文字列の長さは、64KB未満である必要があります。

戻り値

なし。

アクセス

この関数を使用するには、呼出し元が、指定したデータベースに対してデータベース・デザイン権限(ESS_PRIV_DBDESIGN)を持っている必要があります。

例

         ESS_FUNC_M
ESS_SetDatabaseNote (ESS_HCTX_T hCtx)   
{
   ESS_FUNC_M      sts = ESS_STS_NOERR;
   ESS_STR_T      AppName;
   ESS_STR_T      DbName;    
   ESS_STR_T      DbNote;
   
   AppName = "Sample";
   DbName  = "Basic";
   DbNote  = "This is a test";
   
   sts = EssSetDatabaseNote(hCtx, AppName, DbName,
         DbNote);
   
   return (sts);
}