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

FLGFoundIn

指定されたインスタンスが検出されたオブジェクト・インスタンスまたは オブジェクト・タイプのリストを検索します。 FLGFoundIn は、以下の検索をすることができます。

許可

管理者またはユーザー

構文



APIRET  APIENTRY   FLGFoundIn( PSZ              pszFLGID,
                                  FLGOPTIONS   Options,
                                 PFLGHEADERAREA * ppListStruct,
                                  PFLGEXTCODE  pExtCode );

パラメーター

pszFLGID (PSZ) − 入力
その親のリストが検索されるオブジェクト・インスタンスの 16 文字の オブジェクト・インスタンス ID (FLGID) を指します。

この ID の 1 文字目から 6 文字目までは、このインスタンスの オブジェクト・タイプを識別します。

この ID の 7 文字目から 16 文字目までは、システム生成された固有のインスタンス ID です。

指定する FLGID は、何をリストしたいかによります。

Attachment
Attachment 区分のオブジェクト・インスタンスの FLGID (指定され たオブジェクト・インスタンスが Comments オブジェクトとして付加された オブジェクト・インスタンスを検索します。)

Contact
Contact 区分のオブジェクト・インスタンスの FLGID (指定された オブジェクト・インスタンスが Contact であるオブジェクト・インスタンス を検索します。)

Containees
Elemental または Grouping 区分のオブジェクト・インスタンス の FLGID (指定されたオブジェクト・インスタンスを含 む Grouping オブジェクト・インスタンスを検索します。)

Program
Program 区分のオブジェクト・インスタンスの FLGID (指定され た Programs オブジェクト・インスタンスが関連するオブジェクト・タイプ を検索します。)

Options (FLGOPTIONS) − 入力
以下のいずれかのオプションを選択します。

FLG_LIST_ATTACHMENT
指定されたオブジェクト・インスタンスが Comments オブジェクト として付加されたオブジェクト・インスタンスを検索します。
FLG_LIST_CONTACT
指定されたオブジェクト・インスタンスが Contact である オブジェクト・インスタンスを検索します。
FLG_LIST_CONTAIN
指定されたオブジェクト・インスタンスを含 む Grouping オブジェクト・インスタンスを検索します。
FLG_LIST_PROGRAM
指定された Programs オブジェクト・インスタンスが関連する オブジェクト・タイプを検索します。

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

それぞれの Contain、Contact、または Attachment 関係に、出力構造は、 "found-in"オブジェクト・インスタンスに関する以下の情報を含みます。

すべてのインスタンスは、使用するデータベース管理システムの照合順序に 従って、オブジェクト・タイプ名、オブジェクト・インスタンス名の昇順で分類されます。

各 Program 関連について、出力構造は"found-in"オブジェクト・タイプに 関して以下の情報を含んでいます。

すべてのオブジェクト・タイプは、使用するデータベース管理システムの照合順序に従って、 オブジェクト・タイプの 80 文字の外部名 (EXTERNAL NAME OF OBJ TYPE) の 昇順で分類されます。

FLGFoundIn によって戻すことのできるオブジェクト・インスタンス またはオブジェクト・タイプの最大数は、5000 です。

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

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

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

使用方法

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

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

このサンプル・コードは、特定の Contact オブジェクトが検出 されたオブジェクト・インスタンスのリストを検索します。 図 68 は、FLGFoundIn 呼び出しを出すために必要な C 言語コード を示しています。

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

 APIRET            rc;                // reason code from FLGFoundIn
 UCHAR             pszInstID[FLG_ID_LEN + 1];
 FLGOPTIONS        Option=0;          // association type
 PFLGHEADERAREA  * ppReturnObjList;   // pointer to output structure ptr
 FLGEXTCODE       xc=0;             // extended code
   .
   .  /* provide values for input parameters */
   .
 Option = Option | FLG_LIST_CONTACT;
 rc = FLGFoundIn (pszInstID,
                      Option,
                      ppReturnObjList,
                      &xc);
 

図 69 は、FLGFoundIn 呼び出しのための出力構造を表示しています。

図 69. FLGFoundIn の出力構造のサンプル


Figure FLAA2015 not displayed.

このサンプル・コードは、指定された Programs オブジェクト・インスタンス によりハンドルされたオブジェクト・タイプのリストを検索します。 図 70 は、FLGFoundIn 呼び出しを出すために必要な C 言語コード を示しています。

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

 APIRET            rc;                // reason code from FLGFoundIn
 UCHAR             pszInstID[FLG_ID_LEN + 1];
 FLGOPTIONS        Option=0;          // association type
 PFLGHEADERAREA  * ppReturnObjList;   // pointer to output structure ptr
 FLGEXTCODE       xc=0;             // extended code
   .
   .  /* provide values for input parameters */
   .
 Option = Option | FLG_LIST_PROGRAM;
 rc = FLGFoundIn (pszInstID,
                      Option,
                      ppReturnObjList,
                      &xc);

図 71 は、FLGFoundIn 呼び出しのための出力構造を表示しています。

図 71. FLGFoundIn の出力構造のサンプル


Figure FLAA2016 not displayed.


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