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

FLGInit

情報カタログ・マネージャー API DLL を使用するために初期設定し、アプリケーションをデータベースに 接続し、他の API 呼び出しで使用できる環境情報を検索するために使用します。

許可

管理者またはユーザー

構文



APIRET  APIENTRY   FLGInit( PSZ              pszUserID,
                            PSZ              pszPassword,
                            PSZ              pszDatabaseName,
                            FLGADMIN         Admin,
                                 PFLGHEADERAREA * ppListStruct,
                                  PFLGEXTCODE  pExtCode );

パラメーター

pszUserID (PSZ) − 入力
情報カタログ・データベースにログオンするためのユーザー ID を含む、 NULL 文字で終了するストリングを指します。

pszPassword (PSZ) − 入力
ユーザーのパスワードを含む、NULL 文字で終了するストリングを指します。

pszDatabaseName (PSZ) − 入力
情報カタログを表すデータベース別名を含む、NULL 文字で終了するストリングを指します。

admin (FLGADMIN) − 入力
希望するユーザー・オプションを指定します。

FLG_YES
管理者としてログオンします。
FLG_NO
デフォルトです。 ユーザーとしてログオンします。

ppListStruct (PFLGHEADERAREA) − 出力
出力構造を指すポインターのアドレスを指します。 出力構造の形式については、情報カタログ・マネージャーの API 出力構造を参照してください。

出力構造がない場合には出力構造を指すポインターは NULL にセットされ、 情報カタログ・マネージャーは理由コードとともにエラー条件を戻します。

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

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

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

出力構造

FLGInit は、図 83 に示すように、 情報カタログ・マネージャー環境に関する情報が入っている出力構造を作成します。

出力構造のオブジェクト域には、必要な登録およびオブジェクトの特性が ユーザーの使用する国語で示されます。 オブジェクト域には、ユーザーの情報カタログ・マネージャー環境に関する情報を示す値も含ま れています。

図 83. FLGInit 出力構造


Figure FLAA2023 not displayed.

使用方法

出力構造は、すべてのオブジェクト・タイプ登録、オブジェクト・タイプ、 およびオブジェクトに関して必要な 80 バイトの特性名を戻します。

英語版以外の情報カタログ・マネージャーでは、これらの各特性のオブジェクト域 の値は翻訳されています。 FLGCreateReg および FLGCreateType で使用できるように、これらの翻訳された値を保管して おく必要があります。

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

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

表 17 は、FLGInit によって戻される必須特性を示しています。


表 17. FLGInit によって戻される必須特性名
特性名 説明
オブジェクト・タイプの外部名 オブジェクト・タイプ登録における最初の登録特性
物理タイプ名 オブジェクト・タイプ登録における 2 番目の登録特性
DP 名 オブジェクト・タイプ登録における 3 番目の登録特性
作成者 オブジェクト・タイプ登録における 4 番目の登録特性
最終変更者 オブジェクト・タイプ登録における 5 番目の登録特性
最終変更日付および時刻 オブジェクト・タイプ登録における 6 番目の登録特性
オブジェクト・タイプ識別子 オブジェクト・タイプにおける最初の必須特性
インスタンス識別子 オブジェクト・タイプにおける 2 番目の必須特性
名前 オブジェクト・タイプにおける 3 番目の必須特性
最終変更日付および時刻 オブジェクト・タイプにおける 4 番目の必須特性
最終変更者 オブジェクト・タイプにおける 5 番目の必須特性

この出力構造は、環境値も戻します。 他の API 呼び出しで使用できるように、これらの値を保管してください。


表 18. FLGInit によって戻される環境値
特性名 説明
記憶環境 VxRxMx 形式のリリース番号によるデータベース製品名称。 たとえば、次のものがあります。
DB2/NT V07R01M0
DB2 UDB (Windows NT 版) プロダクト
記憶環境サイズ この環境における情報カタログの PTNAME の最大長を示す値。
非適用記号 未指定のデータ・フィールドを表す 1 文字の情報カタログ・マネージャー環境のデフォルト・トークン。 この値は、導入中に設定されたものです。
バージョン 情報カタログ・マネージャーのバージョンを表す 20 文字のインディケーター。
言語 3 文字の各国語コード。たとえば、ENU は英語を表します。 有効な値は以下のとおりです。
CHS
中国語 (簡体字)
CHT
中国語 (繁体字)
DAN
デンマーク語
DEU
ドイツ語
ENU
米国英語
ESP
スペイン語
FIN
フィンランド語
FRA
フランス語
ITA
イタリア語
JPN
日本語
KOR
韓国語
NLB
ベルギー系フランス語
NOR
ノルウェー語
PTB
ブラジル・ポルトガル語
SVE
スウェーデン語
管理者のユーザー ID 現在ログオンしている管理者を表す 8 文字のユーザー ID。
プロダクト・パス 260 文字による情報カタログ・マネージャーの完全な作業パス。
システム・パス長 システムの最大パス長を表す 8 文字の値。
コード・ページ 4 文字のコード・ページ識別子
ユーザー・タイプ 1 文字の識別子。以下のとおりに設定。
A
ログオン・ユーザー ID が 1 次的管理担当者。
B
ログオン・ユーザー ID がバックアップ管理担当者。
D
ログオン・ユーザー ID がオブジェクト管理タスクの実行権限を持つユーザー。
W
ログオン・ユーザー ID がユーザー。

図 84 は、FLGInit API 呼び出しを出すために必要な C 言語コード を示しています。 このサンプル・コードは情報カタログ・マネージャー API DLL を初期設定して、情報アプリケーション が情報カタログ・マネージャー API 呼び出しを出すことができるようにします。

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

 UCHAR          pszUserID[FLG_USERID_LEN + 1];
 UCHAR          pszPassword[FLG_PASSWORD_LEN + 1];
 UCHAR          pszDatabaseName[FLG_DATABASENAME_LEN + 1];
 FLGADMIN       admin = FLG_YES;
 APIRET         rc;                       // reason code
 PFLGHEADERAREA * ppListStruct;   // pointer to output structure pointer
 FLGEXTCODE     ExtCode = 0;                   // Extended code
 .
 .  // IA specific code
 .
 strcpy( pszUserID, "LAUTZ" );
 strcpy( pszPassword, "MYPASSWD");
 strcpy( pszDatabaseName, "CATALOG");
 rc = FLGInit (pszUserName,
               pszPassword,
               pszDatabaseName,
               admin,
                       ppListStruct,
               &ExtCode );
 .  // Issue FLGFreeMem to release the output structure created by FLGInit
 .  // Calls to the FLG API
 .  // When complete, call
 .  // FLGTerm()
 

図 85 にこの出力構造を示します。

図 85. FLGInit のための出力構造のサンプル


Figure FLAA2024 not displayed.


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