Elemental または Grouping オブジェクトに関する Contact オブジェクト のリストを検索するために使用します。
許可
管理者またはユーザー
構文
APIRET APIENTRY FLGListContacts( PSZ pszFLGID,
PFLGHEADERAREA * ppListStruct,
PFLGEXTCODE pExtCode );
パラメーター
この ID の 1 文字目から 6 文字目までは、このインスタンスの オブジェクト・タイプを識別します。
この ID の 7 文字目から 16 文字目までは、システム生成された固有のインスタンス ID です。
この出力構造には、各 Contact オブジェクトの 16 文字 の FLGID と 80 文字の外部名が入ります。
リスト内の項目は、情報カタログによって使用されるデータベース管理システム で使用している照合順序に従って、最初にオブジェクト・タイプ名によって 分類され、次に各インスタンスの名前特性の値によって分類されます。
FLGListContacts によって戻すことのできる Contact オブジェクト・インスタンスの 最大数は計算機で使用可能な記憶域によって異なり、約 5000 です。
戻された理由コードの説明については、付録 D, 情報カタログ・マネージャーの理由コードを参照してくだ さい。
出力構造
FLGListContacts は、図 101 に示すように、Contact のリストが 入っている出力構造を作成します。
出力構造のオブジェクト域には、指定されたオブジェクト・インスタンスに 関連する Contact オブジェクト・インスタンスのリストが入ります。 これらの Contact オブジェクトは、各オブジェクト・インスタンスの FLGID の 値と外部名によって識別されます。
使用方法
出力構造に割り振られたメモリーの解放
FLGListContacts が出力構造にあるデータを戻した場合、出力構造に戻されたデータを 保管してから、FLGFreeMem を呼び出さなくてはなりません (FLGFreeMem参照)。 メモリーを解放するのに、たとえば C 言語指示のような他の方式は使用しないで ください。
図 102 は、FLGListContacts API 呼び出しを出すために必要な C 言語コード を示しています。 このサンプル・コードは、Elemental オブジェクト MYREPORT に関する Contact の リストを検索します。
図 102. C 言語による FLGListContacts の呼び出しのサンプル
APIRET rc; // reason code from FLGListContacts
UCHAR pszFLGID[FLG_ID_LEN + 1];
PFLGHEADERarea * ppListStruct; // pointer to output structure pointer
FLGEXTCODE ExtCode=0; // extended code
.
. /* allocate storage for input parms */
. /* set objid to FLGID of 'MYREPORT' */
.
rc = FLGListContacts (pszFLGID,
ppListStruct, // address of output structure pointer
&ExtCode);
図 103 は、この API 呼び出しのための出力構造を示して います。
図 103. FLGListContacts のための出力構造のサンプル