コマンドラインインターフェイス
コマンドラインインターフェイス
コマンドラインインターフェイスは単独の実行形式ファイルとして提供されます。Windows のバッチファイルから呼び出すことができます。
Antenna House Office Servers SpreadSheet API V0.1 のコマンドラインインターフェイスは、標準入力からファイルを読み込み動作させることができます。
実行形式ファイル名は以下のとおりです。
| Windows | AHOOXMLManagerCmd.exe |
|---|
これらを実行させるためには、いくつかの 環境変数 の設定が必要です。 Windows版では、インストール時にそれらが設定されています。
Antenna House Office Servers SpreadSheet API V0.1 Windows版のコマンドラインプログラムを実行するには、次のようにします。
Antenna House Office Servers SpreadSheet API V0.1 Windows版が正しくインストールされていれば、以下のメッセージが表示されて samples\testFiles\SampleFiles ディレクトリにSplitPerSheet_Example_シート名.xlsx が作成されます。
コマンドラインインターフェイスでは以下のパラメータが指定できます。
パラメータの指定文字と値の間は半角空白を入れてください。また、パス名を指定する場合など内容に空白が含まれるときはダブルクォートで囲んでください。
ダブルクォートでパスを囲む際に末尾が"\"の場合は"\\"としてください。
同一のパラメータ、あるいは背反するパラメータが指定された場合は、エラーになります。
デフォルトのパラメータを環境変数で指定しておくことができます。環境変数での指定は、ここで指定したパラメータの前に補われて評価されます。
| パラメータ | 機能 |
|---|---|
| SplitFileTools |
ファイル分割の実行を指定するコマンドで、詳細のオプションは後続で指定する |
| MergeFilesTools |
ファイル結合の実行を指定するコマンドで、詳細のオプションは後続で指定する |
| Utilitys |
シートの操作ツールを指定するコマンドで、詳細のオプションは後続で指定する |
| help |
コマンドラインインタフェースのパラメータの簡単な解説を表示します。
このパラメータが指定されている場合は、ツールは実行されません。 |
| version |
ツールのバージョン情報を表示します。 このパラメータが指定されている場合は、ツールは実行されません。 |
| パラメータ | 機能 |
|---|---|
|
-i 入力ファイル --inputFilePath 入力ファイル |
ファイル分割ツールの入力ファイルのURIを指定します。 |
|
-o 出力ディレクトリ --outputDirectory 出力ディレクトリ |
ファイル分割ツールの実行結果を出力するディレクトリを指定します。 |
|
-m 実行メソッド --method 実行メソッド |
ファイル分割ツールの実行するメソッドを指定します。 |
| --sheetNames 抽出シート名 | ファイル分割ツールの実行するメソッドを指定します。 |
| パラメータ | 機能 |
|---|---|
|
-i 結合先ファイル --inputFilePath 結合先ファイル |
ファイル結合で基準となるファイルのURIを指定します。 |
|
-o 出力ファイル --outputFilePath 出力ファイル |
ファイル結合ツールの実行結果のファイルのURIを指定します。 |
| --addFilesPaths 追加ファイル | ファイル結合で基準となるファイルにシートを追加するファイルのURIを指定します。 |
| パラメータ | 機能 |
|---|---|
|
-i 入力ファイル --inputFilePath 入力ファイル |
目次を作成するファイルのURIを指定します。 |
|
-o 出力ファイル --outputFilePath 出力ファイル |
目次を作成したファイルのURIを指定します。 |
|
-n 目次シート名 --contentsSheetName 目次シート名 |
目次ページのシート名を指定します。 |
コマンドラインインターフェイスで変換を実行したとき、変換が成功した場合は 0 を、失敗した場合は 1 を戻り値として処理を終えます。helpやversionなどでツールを実行しなかった場合の戻り値は 0 です。