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

FLGListAnchors

Grouping 区分のすべてのアンカー・インスタンスのリストを検索します。 アンカー とは、他のオブジェクトを含むが、 他のオブジェクトには含まれない Grouping 区分のオブジェクトのことを言います。

許可

管理者またはユーザー

構文



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

パラメーター

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

この出力構造には、各アンカー・オブジェクト・インスタンスに関する 以下の情報が入ります。

すべてのインスタンスは、情報カタログに使用されたデータベースの照合順序 に従って、最初にオブジェクト・タイプ名、次に名前によって分類されます。

FLGListAnchors によって戻すことのできるオブジェクト・インスタンスの最大数は 1600 です。

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

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

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

出力構造

FLGListAnchors は、図 86 に示すように、アンカーのリスト が入っている出力構造を作成します。

この出力構造のオブジェクト域には アンカー・オブジェクト・インスタンスのリストが入ります。 各オブジェクト・インスタンスは、FLGID の値と外部名で識別されます。

図 86. FLGListAnchors 出力構造


Figure FLAA2025 not displayed.

使用方法

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

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

図 87 は、FLGListAnchors API 呼び出しを出すために必要な C 言語コード を示しています。 このサンプル・コードは、情報カタログからアンカーのリストを検索します。

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

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

図 88 にこの出力構造を示します。

図 88. FLGListAnchors のための出力構造のサンプル


Figure FLAA2026 not displayed.


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