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

FLGListAssociates

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

許可

管理者またはユーザー

構文



APIRET  APIENTRY   FLGListAssociates( PSZ              pszInBuffer,
                                  FLGOPTIONS   Options,
                                 PFLGHEADERAREA * ppListStruct,
                                  PFLGEXTCODE  pExtCode );

パラメーター

pszInBuffer (PSZ) − 入力
オブジェクト・インスタンスの 16 文字の システム生成された固有の識別子、またはオブジェクト・タイプの 6 文字のシステム生成され た固有の識別子のいずれかを含む入力バッファーを指します。 これはリストするものによって異なります。

Attachment
非 Attachment 区分のオブジェクト・インスタンスのオブジェクト・インスタンス ID (FLGID)。

Comments
非 Comments タイプのオブジェクト・インスタンスの FLGID

Contact
Elemental または Grouping 区分のオブジェクト・インスタンスの FLGID

Containees
Grouping 区分のオブジェクト・インスタンスの FLGID

Links
Elemental または Grouping 区分のオブジェクト・インスタンスの FLGID

Program
非 Program 区分オブジェクト・タイプのオブジェクト・タイプ ID

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

FLG_LIST_ATTACHMENT
指定されたインスタンスと Attachment 関係にあるオブジェクト・インスタンス を検索します。
FLG_LIST_COMMENTS
指定されたインスタンスに付加された Comments オブジェクト・インスタンス を検索します。 FLG_LIST_COMMENTS は、FLG_LIST_ATTACHMENT と同じオブジェクト・インスタンス を検索しますが、各インスタンスについて、より多くの情報 (最終変更日付および時刻、 作成者) を戻します。
FLG_LIST_CONTACT
指定されたインスタンスに付加された Contact オブジェクト・インスタンス を検索します。
FLG_LIST_CONTAIN
指定されたインスタンスに含まれるオブジェクト・インスタンスを検索します。
FLG_LIST_LINK
指定されたインスタンスにリンクしたオブジェクト・インスタンスを検索 します。
FLG_LIST_PROGRAM
指定されたオブジェクト・タイプに関連した Programs オブジェクト・インスタンスを検索します。

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

各インスタンスの出力構造には、以下の情報が示されます。

FLGID (16 文字)

名前 (80 文字)

さらに、FLG_LIST_CONTAIN では、各インスタンスの出力構造が、それ自体 が包含側であるかどうかを示すフラグ (CHILDIND) も示します。 FLG_LIST_COMMENTS では、各インスタンスの出力構造は、以下の事項も含みます。

最終変更日付および時刻

作成者

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

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

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

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

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

使用方法

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

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

このサンプル・コードは、Grouping オブジェクト・タイプ、MYREGION に関連 した Programs オブジェクト・インスタンスのリストを検索します。 図 89 は、FLGListAssociates 呼び出しを出すために必要な C 言語コード を示しています。

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

 APIRET         rc;                       // reason code
 UCHAR           pszObjTypeID[FLG_OBJTYPID_LEN + 1];
 PFLGHEADERAREA * ppReturnObjList;   // ptr to output structure ptr
 FLGOPTIONS       Option=0;
 FLGEXTCODE       xc=0;             // extended code
   .
   .
   .
 Option=Option | FLG_LIST_PROGRAM;
 rc = FLGListAssociates (pszObjTypeID,
                      Option,
                      ppReturnObjList,
                      &xc); 

図 90 は、図 89 にあ る FLGListAssociates 呼び出しのための出力構造を示しています。

図 90. FLGListAssociates のための出力構造のサンプル


Figure FLAA2027 not displayed.

このサンプル・コードは、Grouping オブジェクト、MYBGROUP に含まれる オブジェクト・インスタンスを検索します。 図 91 は、FLGListAssociates 呼び出しを出すために必要な C 言語コード を示しています。

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

 APIRET         rc;                       // reason code
 UCHAR            objid[FLG_ID_LEN + 1];
 PFLGHEADERAREA * ppReturnObjList;   // ptr to output structure ptr
 FLGOPTIONS       Option=0;
 FLGEXTCODE       xc=0;             // extended code
   .
   .
   .
 Option=Option | FLG_LIST_CONTAIN;
 rc = FLGListAssociates (objid,
                      Option,
                      ppReturnObjList,
                      &xc);
 

図 92 は、図 91 にあ る FLGListAssociates 呼び出しのための出力構造を示しています。

図 92. FLGListAssociates のための出力構造のサンプル


Figure FLAA2028 not displayed.

このサンプル・コードは、Grouping オブジェクト、 MYBGROUP の Contact オブジェクト・インスタンスを検索します。 図 93 は、FLGListAssociates 呼び出しを出すために必要な C 言語コード を示しています。

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

 APIRET         rc;                       // reason code
 UCHAR            objid[FLG_ID_LEN + 1];
 PFLGHEADERAREA * ppReturnObjList;   // ptr to output structure ptr
 FLGOPTIONS       Option=0;
 FLGEXTCODE       xc=0;             // extended code
   .
   .
   .
 Option=Option | FLG_LIST_CONTACT;
 rc = FLGListAssociates (objid,
                      Option,
                      ppReturnObjList,
                      &xc);
 

図 94 は、図 93 にあ る FLGListAssociates 呼び出しのための出力構造を示しています。

図 94. FLGListAssociates のための出力構造のサンプル


Figure FLAA2029 not displayed.

このサンプル・コードは、Grouping オブジェクト、 MYBGROUP の Attachment 区分のオブジェクト・インスタンスを検索します。 図 95 は、FLGListAssociates 呼び出しを出すために必要な C 言語コード を示しています。

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

 APIRET         rc;                       // reason code
 UCHAR            objid[FLG_ID_LEN + 1];
 PFLGHEADERAREA * ppReturnObjList;   // ptr to output structure ptr
 FLGOPTIONS       Option=0;
 FLGEXTCODE       xc=0;             // extended code
   .
   .
   .
 Option=Option | FLG_LIST_ATTACHMENT;
 rc = FLGListAssociates (objid,
                      Option,
                      ppReturnObjList,
                      &xc);
 

図 96 は、図 95 にあ る FLGListAssociates 呼び出しのための出力構造を示しています。

図 96. FLGListAssociates のための出力構造のサンプル


Figure FLAA2030 not displayed.

このサンプル・コードは、Elemental オブジェクト、MYREPORT に 付加された Comments オブジェクト・インスタンスを検索します。 図 97 は、FLGListAssociates 呼び出しを出すために必要な C 言語コード を示しています。

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

 APIRET         rc;                       // reason code
 UCHAR            objid[FLG_ID_LEN + 1];
 PFLGHEADERAREA * ppReturnObjList;   // ptr to output structure ptr
 FLGOPTIONS       Option=0;
 FLGEXTCODE       xc=0;             // extended code
   .
   .
   .
 Option=Option | FLG_LIST_COMMENTS;
 rc = FLGListAssociates (objid,
                      Option,
                      ppReturnObjList,
                      &xc);
 

図 98 は、図 97 にあ る FLGListAssociates 呼び出しのための出力構造を示しています。

図 98. FLGListAssociates のための出力構造のサンプル


Figure FLAA2031 not displayed.

このサンプル・コードは、Grouping オブジェクト、MYBGROUP がリンクしてい るオブジェクト・インスタンスを検索します。 図 99 は、FLGListAssociates 呼び出しを出すために必要な C 言語コード を示しています。

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

 APIRET         rc;                       // reason code
 UCHAR            objid[FLG_ID_LEN + 1];
 PFLGHEADERAREA * ppReturnObjList;   // ptr to output structure ptr
 FLGOPTIONS       Option=0;
 FLGEXTCODE       xc=0;             // extended code
   .
   .
   .
 Option=Option | FLG_LIST_LINK;
 rc = FLGListAssociates (objid,
                      Option,
                      ppReturnObjList,
                      &xc);
 

図 100 は、図 99 にあ る FLGListAssociates 呼び出しのための出力構造を示しています。

図 100. FLGListAssociates のための出力構造のサンプル


Figure FLAA2032 not displayed.


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