Attachment、Contact、または Program 区分のすべてのオーファン・インスタンス のリストを検索します。 オーファン とは、ほかのオブジェクト・インスタンスに関連し ていない Attachment、または Contact オブジェクト、または、どのオブジェクト・タイプとも関連していな い Program オブジェクトを指します。
このリストを使用して、オーファン・オブジェクト・インスタンスをほかの オブジェクトに関連付けたり、オーファン・インスタンスを削除したりして、 情報カタログを整頓することができます。
許可
管理者またはユーザー
構文
APIRET APIENTRY FLGListOrphans( PSZ pszObjTypeID,
FLGOPTIONS Options,
PFLGHEADERAREA * ppListStruct,
PFLGEXTCODE pExtCode );
パラメーター
pszObjTypeID が NULL のとき、情報カタログ・マネージャーは、Attachment 区分 (FLG_LIST_ATTACHMENT が 指定されている場合)、または Contact 区分 (FLG_LIST_CONTACT が指定されている 場合) にあるすべてのオブジェクト・タイプのオーファンを戻します。
各インスタンスの出力構造には、以下の情報が示されます。
FLGID (16 文字)
名前 (80 文字)
さらに、FLG_LIST_COMMENTS では、各インスタンスの出力構造は、以下の事項も含 みます。
最終変更日付および時刻
作成者
すべてのインスタンスは、使用するデータベース管理システムの照合順序に 従って、オブジェクト・タイプ名、オブジェクト・インスタンス名の昇順で分類されます。
FLGListOrphans によって戻すことのできるオブジェクト・インスタンスの最大数は、1600 です。
戻された理由コードの説明については、付録 D, 情報カタログ・マネージャーの理由コードを参照してくだ さい。
使用方法
制約事項
ユーザーが FLGListOrphans を使って、オーファンである Comments をリストすると、 FLGListOrphans は、ユーザーが作成者でもある Comments のみを戻します。
出力構造に割り振られたメモリーの解放
FLGListOrphans が出力構造にあるデータを戻した場合、出力構造に戻されたデータを 保管してから、FLGFreeMem を呼び出さなくてはなりません (FLGFreeMem参照)。 メモリーを解放するのに、たとえば C 言語指示のような他の方式は使用しないで ください。
このサンプル・コードは、オーファンであるすべての Program 区分 のオブジェクト・インスタンスを検索します。 図 107 は、FLGListOrphans 呼び出しを出すために必要な C 言語コード を示しています。
図 107. C 言語による FLGListOrphans の呼び出しのサンプル
APIRET rc; // reason code
PFLGHEADERAREA * ppReturnObjList; // ptr to output structure ptr
FLGOPTIONS Option=0;
FLGEXTCODE xc=0; // extended code
.
.
.
Option=Option | FLG_LIST_PROGRAM;
rc = FLGListOrphans (NULL,
Option,
ppReturnObjList,
&xc);
図 108 は、図 107 にあ る FLGListOrphans 呼び出しのための出力構造を示しています。
図 108. FLGListOrphans のための出力構造のサンプル
このサンプル・コードは、オーファンであるすべての Contact 区分 のオブジェクト・インスタンスを検索します。 図 109 は、FLGListOrphans 呼び出しを出すために必要な C 言語コード を示しています。
図 109. C 言語による FLGListOrphans の呼び出しのサンプル
APIRET rc; // reason code
PFLGHEADERAREA * ppReturnObjList; // ptr to output structure ptr
FLGOPTIONS Option=0;
FLGEXTCODE xc=0; // extended code
.
.
.
Option=Option | FLG_LIST_CONTACT;
rc = FLGListOrphans (NULL,
Option,
ppReturnObjList,
&xc);
図 110 は、図 109 にあ る FLGListOrphans 呼び出しのための出力構造を示しています。
図 110. FLGListOrphans のための出力構造のサンプル
このサンプル・コードは、オーファンであるすべての Attachment 区分 のオブジェクト・インスタンスを検索します。 図 111 は、FLGListOrphans 呼び出しを出すために必要な C 言語コード を示しています。
図 111. C 言語による FLGListOrphans の呼び出しのサンプル
APIRET rc; // reason code
PFLGHEADERAREA * ppReturnObjList; // ptr to output structure ptr
FLGOPTIONS Option=0;
FLGEXTCODE xc=0; // extended code
.
.
.
Option=Option | FLG_LIST_ATTACHMENT;
rc = FLGListOrphans (NULL,
Option,
ppReturnObjList,
&xc);
図 112 は、図 111 にあ る FLGListOrphans 呼び出しのための出力構造を示しています。
図 112. FLGListOrphans のための出力構造のサンプル
このサンプル・コードは、Comments オブジェクト・タイプである、 すべてのオーファン Attachment 区分オブジェクト・インスタンスを 検索します。 図 113 は、FLGListOrphans 呼び出しを出すために必要な C 言語コード を示しています。
図 113. C 言語による FLGListOrphans の呼び出しのサンプル
APIRET rc; // reason code
PFLGHEADERAREA * ppReturnObjList; // ptr to output structure ptr
FLGOPTIONS Option=0;
FLGEXTCODE xc=0; // extended code
.
.
.
Option=Option | FLG_LIST_COMMENTS;
rc = FLGListOrphans (NULL,
Option,
ppReturnObjList,
&xc);
図 114 は、図 113 にあ る FLGListOrphans 呼び出しのための出力構造を示しています。 この特別な出力構造には、2 つの付加的な特性値があります。
図 114. FLGListOrphans のための出力構造のサンプル