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

FLGGetInst

指定されたオブジェクト・タイプに関する単一のオブジェクト・インスタンス を検索するために使用します。

許可

管理者またはユーザー

構文



APIRET  APIENTRY     FLGGetInst( PSZ              pszFLGID,
                                 PFLGHEADERAREA * ppObjInstStruct,
                                  PFLGEXTCODE  pExtCode );

パラメーター

pszFLGID (PSZ) − 入力
検索するインスタンスを表す 16 文字のシステム生成された固有の ID を指 します。

この ID の 1 文字目から 6 文字目までは、このインスタンスの オブジェクト・タイプを識別します。

この ID の 7 文字目から 16 文字目までは、システム生成された固有のインスタンス ID です。

ppObjInstStruct (PFLGHEADERAREA) − 出力
出力構造を指すポインターのアドレスを指します。 FLGGetInst が失敗した場合には、このポインターは NULL にセットされます。

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

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

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

出力構造

FLGGetInst が作成する出力構造には、図 73 に示すように、 要求されたオブジェクト・インスタンスの特性の仕様および値が含まれています。

この出力構造のオブジェクト域には、要求されたオブジェクト・インスタンスの 特性の値が入ります。

図 73. FLGGetInst の出力構造


Figure FLAA2017 not displayed.

バイト・オフセットの意味については、情報カタログ・マネージャーの API 出力構造を参照してくだ さい。

使用方法

前提条件

pszFLGID 入力パラメーターの値は、既存のオブジェクト・インスタンスを 参照するものでなければなりません。

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

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

情報カタログ更新の制御

FLGGetInst はデータベースに対して変更をコミットします。 FLGGetInst 呼び出しの前に行われた予期しない変更が情報カタログ・マネージャーによって コミットされないようにするために、プログラムの中で、FLGGetInst を 出す前に FLGCommit または FLGRollback を出すようにしてください。

図 74 は、FLGGetInst API 呼び出しを出すために必要な C 言語コード を示しています。 このサンプル・コードは、Quality Group オブジェクト・インスタンスに関する 情報を検索します。

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

 APIRET         rc;                   // Declare reason code
 UCHAR          pszFLGID[FLG_ID_LEN+1];   // Unique ID for "Quality Group"
 PFLGHEADERAREA * ppObjInstStruct;        // Pointer to the output structure
 FLGEXTCODE     ExtCode = 0;                // Declare extended code
   .
   .  /* Retrieving an object Instance  */
   .
 strcpy (pszFLGID,"0000330000001234");
 rc = FLGGetInst  (pszFLGID,        // Instance ID
                   ppObjInstStruct, // Structure pointer where output will be returned
                    &ExtCode);             // Pass pointer to extended code
 

図 75 は、このオブジェクト・インスタンスの特性と値の 情報が入っている出力構造を示しています。

図 75. FLGGetInst のための出力構造のサンプル


Figure FLAA2018 not displayed.


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