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

FLGListOrphans

Attachment、Contact、または Program 区分のすべてのオーファン・インスタンス のリストを検索します。 オーファン とは、ほかのオブジェクト・インスタンスに関連し ていない Attachment、または Contact オブジェクト、または、どのオブジェクト・タイプとも関連していな い Program オブジェクトを指します。

このリストを使用して、オーファン・オブジェクト・インスタンスをほかの オブジェクトに関連付けたり、オーファン・インスタンスを削除したりして、 情報カタログを整頓することができます。

許可

管理者またはユーザー

構文



APIRET  APIENTRY   FLGListOrphans( PSZ              pszObjTypeID,
                                  FLGOPTIONS   Options,
                                 PFLGHEADERAREA * ppListStruct,
                                  PFLGEXTCODE  pExtCode );

パラメーター

pszObjTypeID (PSZ) − 入力
存在しているが、現在はどのオブジェクト・インスタンスとも関連してい ないインスタンスのリストを検索するオブジェクト・タイプの 6 文字のシステム生成 された固有の識別子 (オブジェクト・タイプ ID)。 指定するオブジェクト・タイプ ID は、何をリストしたいかによります。

Attachment
Attachment 区分オブジェクト・タイプ ID

Comments
このパラメーターは無視されます。

Contact
Contact 区分オブジェクト・タイプ ID

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

pszObjTypeID が NULL のとき、情報カタログ・マネージャーは、Attachment 区分 (FLG_LIST_ATTACHMENT が 指定されている場合)、または Contact 区分 (FLG_LIST_CONTACT が指定されている 場合) にあるすべてのオブジェクト・タイプのオーファンを戻します。

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

FLG_LIST_ATTACHMENT
現在、付加されていない Attachment 区分のオブジェクト・インスタンスを検索 します。

FLG_LIST_COMMENTS
現在、付加されていない Comments オブジェクト・インスタンスを検索します。 FLG_LIST_COMMENTS は、FLG_LIST_ATTACHMENT と同じオブジェクト・インスタンス を検索しますが、各インスタンスについて、より多くの情報 (最終変更日付および 時刻、作成者) を戻します。

FLG_LIST_CONTACT
現在、付加されていない Contact 区分のオブジェクト・インスタンスを検索 します。

FLG_LIST_PROGRAM
現在、どのオブジェクト・タイプにも関連していない Programs オブジェクト・インスタンスを 検索します。

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

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

FLGID (16 文字)

名前 (80 文字)

さらに、FLG_LIST_COMMENTS では、各インスタンスの出力構造は、以下の事項も含 みます。

最終変更日付および時刻

作成者

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

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

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

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

戻された理由コードの説明については、付録 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 のための出力構造のサンプル


Figure FLAA2037 not displayed.

このサンプル・コードは、オーファンであるすべての 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 のための出力構造のサンプル


Figure FLAA2038 not displayed.

このサンプル・コードは、オーファンであるすべての 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 のための出力構造のサンプル


Figure FLAA2039 not displayed.

このサンプル・コードは、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 のための出力構造のサンプル


Figure FLAA2040 not displayed.


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