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

FLGExport

情報カタログからメタデータを検索してファイル内のタグ言語に変換する ために使用します。

許可

管理者または許可ユーザー

構文



APIRET  APIENTRY   FLGExport( PSZ              pszTagFileID,
                                  PSZ              pszLogFileID,
                              PSZ              pszIcoPath,
                                   PFLGHEADERAREA   pListStruct,
                                  PFLGEXTCODE  pExtCode );

パラメーター

pszTagFileID (PSZ) − 入力
出力タグ言語ファイルの名前を指します。 このパラメーターは必須パラメーターです。

このパラメーターにはドライブ、ディレクトリー・パス、およびファイル名が 含まれており、ファイル割り振りテーブル (FAT) または HPFS ファイルとして 有効な値でなければなりません。 このファイルのターゲット・ドライブは、固定ディスクであっても、 取り外し可能ディスクであっても差し支えありません。 ファイル名だけを入力すると、情報カタログ・マネージャー側は、タグ言語ファイルを DGWPATH 環境変数 で示されるドライブおよびパスに配置します。

このターゲット・タグ言語ファイルが存在していてはなりません。 情報カタログ・マネージャーは既存のタグ・ファイルへの上書きは行いません。

(ドライブおよびディレクトリーを除く) ファイル名とエクステンションは、 240 文字を超えてはなりません。 タグ言語ファイル ID が全体で 259 文字を超えてはなりません。

pszLogFileID (PSZ) − 入力
ログ・ファイルの名前を指します。 このパラメーターは必須パラメーターです。

このパラメーターにはドライブ、ディレクトリー・パス、およびファイル名が 含まれており、FAT または HPFS ファイルとして有効な値でなければなりません。 ログ・ファイルのターゲット・ドライブは、固定ディスクでなければなりません。 ログ・ファイル ID は 259 文字を超えてはなりません。 ファイル名だけを指定すると、情報カタログ・マネージャー側は、ログ・ファイルを DGWPATH 環境変数 で示されるドライブおよびパスに配置します。

このパラメーターで指定されたログ・ファイルが存在していない場合には、 新しいファイルが作成されます。 このパラメーターで指定されたログ・ファイルがすでに存在している場合には、 FLGExport API 呼び出しはそれに対して行われます。

pszIcoPath (PSZ) − 入力
OS/2(R) または Windows のアイコン・ファイルを含むパスの仕様を指します。

このパラメーターは任意選択です。 このパラメーターが NULL の場合、アイコン・ファイルのエクスポートは行われ ません。

このパラメーターにはドライブおよびディレクトリーが含まれており、 FAT または HPFS ファイルとして有効な値でなければなりません。 このパラメーターは、246 文字を超えてはなりません。

このパラメーターを指定する場合、アイコン・ファイルの ターゲット・ドライブは固定ディスクでなければなりません。

pListStruct (PFLGHEADERAREA) − 入力
エクスポートされるオブジェクトのリストとエクスポート・オプション を含んでいる入力構造を指します。

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

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

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

入力構造

FLGExport を使用するには、図 65 に示す入力構造を定義し なければなりません。 この構造はヘッダー域、定義域、およびオブジェクト域からなります。

図 65. FLGExport 入力構造


Figure FLAA2013 not displayed.

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

使用方法

入力構造

FLGExport 入力構造の定義域は、図 65 に示すとおりに指定 しなければなりません。

FLGExport の入力構造には、以下の情報が入ります。

FLGID
エクスポートされるインスタンスの 16 文字のシステム生成された固有の識別子。

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

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

任意の情報カタログ・マネージャー・オブジェクト・インスタンスをエクスポートすることができます。

CONTAINEE-IND
情報カタログ・マネージャーがこのオブジェクトに含まれるすべてのオブジェクトをエクスポート するのかどうかを指定する、1 文字のインディケーター (Y | N) です。 このインディケーターは Grouping オブジェクトだけに適用され、 それ以外のすべてのオブジェクトについては無視されます。

CONTACT-IND
情報カタログ・マネージャーが Grouping および Elemental オブジェクトの関連 Contact オブジェクト をすべてエクスポートするのかどうかを指定する、1 文字のインディケーター (Y | N) です。 このインディケーターは Grouping および Elemental オブジェクトだけに適用され、 それ以外のすべてのオブジェクトについては無視されます。

ATTACHMENT-IND
情報カタログ・マネージャーが指定されたオブジェクト・インスタンスに付加された Attachment オブジェクト をすべてエクスポートするのかどうかを指定する、1 文字のインディケーター (Y | N) です。 このインディケーターは、指定されたオブジェクトが Attachment オブジェクトであると、 無視されます。

LINK-IND
情報カタログ・マネージャーが指定されたオブジェクト・インスタンスにリンクした すべての Grouping および Elemental オブジェクト・インスタンスをすべて エクスポートするのかどうかを指定する、1 文字のインディケーター (Y | N) です。 このインディケーターは Grouping および Elemental オブジェクトだけに適用され、 それ以外のすべてのオブジェクトについては無視されます。

生成されるタグ言語ファイル

FLGExport は、エクスポートされる各オブジェクト・インスタンスのタグを含む タグ言語ファイルを生成します。 インディケーターに何を指定するかによって、表 16 に示され ているようにオブジェクト・インスタンスがエクスポートされます。


表 16. インディケーターの組み合わせによってタグ言語ファイルにエクスポートされるオブジェクト・インスタンス
インディケーターの値 エクスポート:
CONTAINEE CONTACT ATTACHMENT LINK
Y Y Y Y a から j
Y Y Y N a、b、c、d、g、h、i、j
Y Y N Y a、b、e、f、g、h
Y Y N N a、b、g、h
Y N Y Y a、b、c、d、e、f
Y N Y N a、b、c、d
Y N N N a、b
Y N N Y a、b、e、f
N Y Y Y a、c、e、g、i
N Y Y N a、c、g、i
N Y N Y a、e、g
N N Y Y a、c、e
N N Y N a、c
N N N Y a、e
N N N N a のみ
注:
a
指定されたオブジェクト・インスタンス
b
a に含まれるオブジェクト・インスタンス
c
a に付加されたコメント
d
b に付加されたコメント
e
a へのリンク
f
b へのリンク
g
a への連絡
h
b への連絡
i
g に付加されたコメント
j
h に付加されたコメント

FLGExport は、頻繁に使用される COMMIT タグをタグ言語ファイル内に生成します。

FLGExport は、各オブジェクト・タイプに関連付けられたアイコンのコピーを、 指定されたアイコン・パスに収めます。 このオブジェクト・タイプに別のアイコンが関連付けられていない 場合、FLGExport はデフォルトの区分をエクスポートしません。 エクスポートされたアイコン・ファイルの名前は、オブジェクト・タイプ の DP 名 (省略名) に、OS/2 アイコンの場合は .ICO、Windows アイコン の場合は .ICW のエクステンションが付いたものになります。

メタデータをディスケットにエクスポートする際の VisualAge C++ プログラムの連係

C 言語プログラムによって情報カタログ・マネージャー情報をディスケットにエクスポート する FLGExport 呼び出しが出される場合には、情報カタログ・マネージャーが プレゼンテーション・マネージャー(R) (PM) のインターフェース表示メッセージ を使用して、必要なときにディスケットを挿入するようにユーザーに 指示できるようにするために、そのプログラムを WINDOWAPI タイプの アプリケーションと連係させてください。

この連係は、次のいずれかの方法を使用して行うことができます。

図 66 は、FLGExport API 呼び出しを出すために必要な C 言語コード を示しています。 このサンプル・コードは 3 つの情報カタログ・マネージャー・オブジェクトをエクスポートします。 これらの 3 つのオブジェクトは、すべて Grouping オブジェクトです。

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

 APIRET         rc;                   // Declare reason code
 UCHAR   pszTagFileID[FLG_TAG_FILE_ID_MAXLEN + 1]; // Tag file id
 UCHAR   pszLogFileID[FLG_LOG_FILE_ID_MAXLEN + 1]; // Log file id
 UCHAR   pszIcoPath[FLG_ICON_PATH_MAXLEN + 1];  // icon files path
 PFLGHEADERAREA  pListStruct;  // pointer to the input structure
 FLGEXTCODE     ExtCode=0;   // declare an extended code for API
   .
   .  /* set values for Tag file/ Log file/ Icon path   */
   .  /* create object list             */
   .
 rc  = FLGExport (pszTagFileID,
                 pszLogFileID,
                  pszIcoPath,
                  pListStruct,          // Pass input structure
                    &ExtCode);             // Pass pointer to extended code
   

図 67 は、この FLGExport 呼び出しのための入力構造を示して います。

図 67. FLGExport のための入力構造のサンプル


Figure FLAA2014 not displayed.


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