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

FLGManageCommentStatus

情報カタログ・マネージャー・インターフェースを使って、情報カタログで作成す る Comments オブジェクトをユーザーが割り当てるのに、現在 利用可能な選択項目のリストを設定します。 たとえば、状況選択項目には、 オープン、保留、必要なアクション、クローズなどがあります。

許可

管理者; ユーザー (FLG_ACTION_GET のみ)

構文



APIRET  APIENTRY   FLGManageCommentStatus( FLGOPTIONS       Action,
                                           FLGHEADERAREA  * pStatusStruct,
                                           PFLGHEADERAREA * ppStatusStruct,
                                  PFLGEXTCODE  pExtCode );

パラメーター

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

FLG_ACTION_GET
Comments オブジェクト・インスタンスの現在の状況選択項目のリストを検索します。
FLG_ACTION_UPDATE
Comments オブジェクト・インスタンスの状況選択項目のリストから、 項目を追加、変更、または削除します。

pStatusStruct (PFLGHEADERAREA) − 入力
FLG_ACTION_UPDATE の Comments オブジェクト・インスタンスの更新 された状況選択項目リストを含む入力構造を指します。

ppStatusStruct (PFLGHEADERAREA) − 出力
FLG_ACTION_GET の Comments オブジェクト・インスタンスの 状況選択項目の現在のリストを含む出力構造を指します。

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

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

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

使用方法

FLGManageCommentStatus を呼び出すたびに、10 項目の定義域すべてと、それに 対応するオブジェクト域にある 10 項目を組み込まなければなりません。 ブランクにしておきたい状況域にはゼロを使用します (図 119 参照)。

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

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

情報カタログ更新の制御

プログラムを可能な限り、情報カタログと同期化させるために、FLGManageCommentStatus が正常に完了 したあとで、呼び出しを FLGCommit (FLGCommit参照) に組み込む必要があります。 FLGManageCommentStatus が正常に完了しない場合は、呼び出し を FLGRollback (FLGRollback参照) に組み込む必要があります。

このサンプル・コードは、状況構造を検索します。 図 118 は、FLGManageCommentStatus 呼び出しを出すために必要な C 言語コード を示しています。

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

 APIRET           rc;               // reason code for API
 FLGOPTIONS       Action=0;
 PFLGHEADERAREA   pStatusStruct;
 FLGEXTCODE       xc=0;             // extended code
   .
   .  /*                                                 */
   .
 Action= Action | FLG_ACTION_GET;  //set get option
 rc = FLGManageCommentStatus (Action,
                      NULL,
                              &pStatusStruct,
                     &xc);
 

図 119 は、図 118 にあ る FLGManageCommentStatus 呼び出しのための出力構造を示しています。

図 119. FLGManageCommentStatus のための出力構造のサンプル


Figure FLAA2043 not displayed.

このサンプル・コードは、状況構造に、追加の状況フィールドを付けて、更新します。 図 120 は、FLGManageCommentStatus 呼び出しを出すために必要な C 言語コード を示しています。

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

 APIRET           rc;               // reason code for API
 FLGOPTIONS       Action=0;
 PFLGHEADERAREA   pStatusStruct;
 FLGEXTCODE       xc=0;             // extended code
   .
   .  /*                                                 */
   .
 Action= Action | FLG_ACTION_UPDATE;  //update option
 rc = FLGManageCommentStatus (Action,
                              pStatusStruct,
                      NULL,
                     &xc);
 

図 121 は、図 120 にあ る FLGManageCommentStatus 呼び出しのための入力構造を示しています。

図 121. FLGManageCommentStatus のための入力構造のサンプル


Figure FLAA2044 not displayed.


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