IServer

www.altova.com このトピックを印刷 前のページ 1つ上のレベル 次のページ

ホーム >  MapForce Server API > API Reference (COM, .NET) > インターフェイス >

IServer

IServer インターフェイスは、新規の MapForce サーバー オブジェクト インスタンスを作成し、 MapForce Server エンジンへのアクセスを与えます。

 

COM プラットフォームで C++ を使用している場合、メインインターフェイスの名前は IServerです。COM プラットフォームで C# または VB.NET,¥ を使用している場合、メインインターフェイスの名前は IServerです。

 

プロパティ

名前

説明

APIMajorVersion

読み取り専用.

MapForce Server API のメジャーなバージョンを取得します。API が他のサーバーに接続されている場合、製品バージョンとは異なる場合があります。

APIMinorVersion

読み取り専用.

MapForce Server API のマイナーバージョンを取得します。API が他のサーバーに接続されている場合、製品バージョンとは異なる場合があります。

APIServicePackVersion

読み取り専用.

MapForce Server API のサービスパックバージョンを取得します。API が他のサーバーに接続されている場合、製品バージョンとは異なる場合があります。

Is64Bit

読み取り専用.

MapForce Server エンジンが 64 ビットの実行可能ファイルの場合、 true を返します。

LastExecutionMessage

読み取り専用.

最後のRunコマンド中に受け取ったメッセージを取得します。

MajorVersion

読み取り専用.

1998 から始まる製品のメジャーバージョンを取得します (例えば、 Altova MapForce Server 2018 のために"20" など )。

MinorVersion

読み取り専用.

製品のマイナーバージョンを取得します (例えば、Altova MapForce Server 2018 r2 のために"2" など)。

ProductName

読み取り専用.

製品の名前を取得します (例えば、Altova MapForce Server など)。

ProductNameAndVersion

読み取り専用.

製品のの完全な名前とバージョンを取得します (例えば、 "Altova MapForce Server 2018 r2 sp1 (x64)")。

ServerPath

MapForce Server 実行可能ファイルへのパスを取得または設定します。

ServicePackVersion

読み取り専用.

製品のサービスパックのバージョンを取得します (例えば、 Altova MapForce Server 2018 r2 sp1 (x64)のために "1" など)。

WorkingDirectory

実行中のジョブのための現在のディレクトリを取得、または、設定します (相対的パスは、作業ディレクトリに対して評価されます)。

 

メソッド

名前

説明

AddParameter

マッピング内で定義されているパラメーターに値を割り当てます。最初の引数は、マッピング上で定義されたとおりにパラメーター名を指定します。2番目の引数はパラメーターの値を指定します。

ClearOptions

SetOption メソッドにより設定されたオプションのリストをクリアします。SetOption メソッドにより設定されたすべてのオプションはオブジェクトのライフタイムの期間有効です。前に設定されたオプションを明示的にクリアする必要がある場合、このメソッドを呼び出します。

ClearParameterList

AddParameter メソッドを使用して設定されたパラメーターのリストをクリアします。

GetOutputParameter

最後の run コマンドから生成された文字列の出力を取得します。出力が生成されない場合 null を返します。この関数は、 MapForce 内の出力コンポーネントの名前を識別する文字列パラメーターを必要とします。

Run

MapForce Server 実行ファイル (.mfx ファイル)を実行します。成功の場合は、trueを返し、それ以外の場合、false を返します。

SetOption

マッピングを実行する前のオプションを設定します。最初の引数は、オプションの名前を指定し、2番目の引数はオプションの値を指定します。このメソッドはマッピングがグローバルリソースを消費するためにデザインされている場合とても役に立ちます (Altova グローバルリソースを参照してください)。現在サポートされているオプションは以下の通りです:

 

globalresourcefile (or gr) - グローバルリソースファイルパス(このオプションが指定されている場合、グローバルリソース構成名も指定されている必要があります。次のアイテムを参照してください)。
globalresourcefile (or gr) - グローバルリソース構成名(このオプションが指定されている場合、グローバルリソースファイルパスも指定されている必要があります。次のアイテムを参照してください)。
catalog - カスタム RootCatalog.xml ファイルへのパスこのオプションによりマッピングにより使用された URL を解決するために使用されたカスタムカタログファイルを指定します。デフォルトのカタログはプログラムインストールディレクトリのサブディレクトリ内にあります。
taxonomy-package - マッピングにより必要とされている場合、カスタム XBRL タクソノミパッケージへのパスです。
taxonomy-package - マッピングにより必要とされている場合、カスタム XBRL タクソノミパッケージ構成へのパスです。

 

設定されたすべてのオプションはオブジェクトのライフタイムの期間有効です。同じ名前でオプションを2回設定すると、前のオプションは上書きされます。明示的にすべてのオプションをクリアするために ClearOptions() メソッドを呼び出します。

 

サンプル

MapForce Server を異なる言語で開始し、実行する方法を次のサンプルは説明しています:

 

C++ サンプル
C# サンプル
VBScript サンプル
VB.NET サンプル

(C) 2019 Altova GmbH