あるオブジェクト・タイプのすべての特性の定義を検索するために使用します。
許可
管理者またはユーザー
構文
APIRET APIENTRY FLGGetType( PSZ pszObjTypeID,
PFLGHEADERAREA * ppObjTypeStruct,
PFLGEXTCODE pExtCode );
パラメーター
戻された理由コードの説明については、付録 D, 情報カタログ・マネージャーの理由コードを参照してくだ さい。
出力構造
FLGGetType は、図 79 に示すように、 要求されたオブジェクト・タイプの特性仕様を含む出力構造を作ります。
出力構造の定義域には、オブジェクト・タイプが作成されたと きに指定された順に、要求されたオブジェクト・タイプの特性が入ります。
バイト・オフセットの意味については、情報カタログ・マネージャー入力および出力構造を参照してくだ さい。
使用方法
前提条件
pszObjTypeID パラメーターの値は、情報カタログに登録された既存の オブジェクト・タイプ ID を参照するものでなければなりません。
出力構造に割り振られたメモリーの解放
FLGGetType が出力構造にあるデータを戻した場合、出力構造に戻されたデータ を保管してから、FLGFreeMem を呼び出さなくてはなりません (FLGFreeMem参照)。 メモリーを解放するのに、たとえば C 言語指示のような他の方式は使用しないで ください。
図 80 は、FLGGetType API 呼び出しを出すために必要な C 言語コード を示しています。 このサンプル・コードは、MYIMAGE オブジェクト・タイプの特性に関する情報を 情報カタログから検索します。
図 80. C 言語による FLGGetType の呼び出しのサンプル
APIRET rc; // Declare reason code
UCHAR pszObjTypeID[FLG_OBJTYPID_LEN + 1]; // Set to ID of MYIMAGE (000044)
PFLGHEADERAREA * ppObjTypeStruct; // Pointer to the output structure
FLGEXTCODE ExtCode=0; // Declare extended code
.
. /* retrieving a user-defined object type - MYIMAGE */
strcpy (pszObjTypeID,"000044");
.
rc = FLGGetType (pszObjTypeID,
ppObjTypeStruct,
&ExtCode); // Pass pointer to extended code
図 81 は、MYIMAGE オブジェクト・タイプの特性情報が 入っている出力構造を示しています。
図 81. FLGGetType のための出力構造のサンプル