EssListFilters

データベースのすべてのフィルタをリストします。

構文

            ESS_FUNC_M EssListFilters (
            hCtx, AppName, DbName, Count, ppFilterList
            );

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	APIコンテキスト・ハンドル。
AppName	ESS_STR_T	アプリケーション名。
DbName	ESS_STR_T	データベース名。
pCount	ESS_PUSHORT_T	フィルタ名のカウントを受け取る変数のアドレス。
ppFilterList	ESS_PPFTRNAME_T	割り当てられたフィルタ名文字列の配列を受け取るポインタのアドレス。

備考

ppFilterListに対して割り当てられたメモリーは、EssFreeを使用して解放する必要があります。

戻り値

正常終了の場合、データベース内のフィルタのカウントがpCountに、フィルタ名の配列がppFilterListに戻されます。

アクセス

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

例

         ESS_FUNC_M 
ESS_ListFilters (ESS_HCTX_T hCtx, ESS_HINST_T hInst)
{
   ESS_FUNC_M       sts = ESS_STS_NOERR;
   ESS_STR_T       AppName;   
   ESS_STR_T       DbName;
   ESS_USHORT_T    Count = 0;            
   ESS_USHORT_T    ind;
   ESS_PFTRNAME_T  pFilterList = NULL;
   
   AppName = "Sample";
   DbName  = "Basic";
   
   sts = EssListFilters(hCtx, AppName, DbName,
         &Count, &pFilterList);
   
   if(!sts)
   {   
      if(Count && pFilterList)
      {  
printf ("\r\n-------Filter List-------\r\n\r\n");    
         for (ind = 0; ind < Count; ind++)
printf("%s\r\n",pFilterList[ind]);
         EssFree (hInst, pFilterList);        
      }
      else
printf ("\r\nFilter List is empty\r\n\r\n");                                                  
   } 
   return (sts);    
}