情報カタログ・マネージャー プログラミングの手引きおよび解説書

FLGListObjTypes

情報カタログ・データベース内で現在登録され、作成されているすべてのオブジェクト・タイプを 表示するために使用します。

許可

管理者またはユーザー

構文



APIRET  APIENTRY  FLGListObjTypes( PFLGHEADERAREA * ppListStruct,
                                  PFLGEXTCODE  pExtCode );

パラメーター

ppListStruct (PFLGHEADERAREA) − 出力
オブジェクト・タイプをリストする出力構造を指すポインターのアドレスを指します。 出力構造がない場合には、構造を指すポインターは NULL にセットされます。

各項目には以下の情報が入ります。

各項目は 80 バイトのオブジェクト・タイプ外部名 (EXTERNAL NAME OF OBJ TYPE) に よって分類されます。実際の順序は、情報カタログに使用されているデータベース管理システム で使用する照合順序に従います。

pExtCode (PFLGEXTCODE) − 出力
理由コードに関連する拡張コードを指します。 戻された理由コードに関連した意味のある拡張コードがあるかどうかについて は、付録 D, 情報カタログ・マネージャーの理由コードを参照してください。

理由コード (APIRET)
この API 呼び出しの実行結果を表します。

戻された理由コードの説明については、付録 D, 情報カタログ・マネージャーの理由コードを参照してくだ さい。

出力構造

FLGListObjTypes は、図 104 に示すように、オブジェクト・タイプ のリストが入っている出力構造を作成します。

出力構造のオブジェクト域には、情報カタログ内のすべての オブジェクト・タイプのリストが入ります。 これらのオブジェクト・タイプは、オブジェクト・タイプ ID の値、 オブジェクト・タイプの外部名、およびオブジェクト・タイプ の DP 名 (省略名) によって識別されます。

図 104. FLGListObjTypes 出力構造


Figure FLAA2035 not displayed.

バイト・オフセットの意味については、情報カタログ・マネージャーの API 出力構造を参照してくだ さい。

使用方法

出力構造に割り振られたメモリーの解放

FLGListObjTypes が出力構造にあるデータを戻した場合、出力構造に戻されたデータを 保管してから、FLGFreeMem を呼び出さなくてはなりません (FLGFreeMem参照)。 メモリーを解放するのに、たとえば C 言語指示のような他の方式は使用しないで ください。

図 105 は、FLGListObjTypes API 呼び出しを出すために必要な C 言語コード を示しています。 このサンプル・コードは、情報カタログからすべてのオブジェクト・タイプの リストを検索します。

図 105. C 言語による FLGListObjTypes の呼び出しのサンプル

 PFLGHEADERAREA * ppListStruct;   // pointer to output structure pointer
 APIRET          rc;            // reason code from FLGListObjTypes
 FLGEXTCODE       ExtCode=0;              // extended code
   .
   .
   .
 rc = FLGListObjTypes (ppListStruct,  // address of output structure pointer
                       &ExtCode);
 

図 106 は、この API 呼び出しのための出力構造を示しています。

図 106. FLGListObjTypes のための出力構造のサンプル


Figure FLAA2036 not displayed.


[ ページのトップ | 前ページ | 次ページ | 目次 | 索引 ]