LabVIEWには定義済みのコマンドライン操作が含まれており、ファイルのコンパイル、アプリケーションのビルド、VIの実行などのタスクを自動化できます。

表 24. 事前定義されたLabVIEWCLI操作
コマンド 説明
MassCompile 指定されたディレクトリのファイルを一括コンパイルします。
ExecuteBuildSpec 指定されたビルド仕様の設定を使用してアプリケーションまたはライブラリをビルドし、出力ファイルのパスを返します。
RunVI 定義済みのコネクタペーンインタフェースでVIを実行し、出力またはエラー情報を返します。
CloseLabVIEW プロンプトなしでLabVIEWを閉じます。
CreateComparisonReport 指定した2つのVIの比較レポートを生成します。
RunVIAnalyzer VI Analyzerツールキット用。LabVIEW VI Analyzerツールキットで指定されたVI Analyzerタスクを実行し、指定された場所にテストレポートを保存します。
RunUnitTests Unit Test Frameworkツールキット用。LabVIEW Unit Test Frameworkツールキットで指定されたファイルに対してテストを実行し、指定された場所にJUnitファイルを保存します。

LabVIEWで実行するカスタムコマンドライン操作を作成することもできます。

MassCompile

指定されたディレクトリのファイルを一括コンパイルします。

表 25. MassCompile引数は、この操作で使用可能な引数を示しています。

表 25. MassCompile引数
引数 必須またはオプション 説明 デフォルト
-DirectoryToCompile 必須 コンパイルするVIの場所。
-MassCompileLogFile オプション ログ結果のファイルのパス。 一時的な場所へのパスです。
-AppendToMassCompileLog オプション 結果をログファイルに追加するかどうかを指定するブール値。 false: 指定されたログファイルがすでに存在する場合、既存のログファイルは上書きされます。
-NumOfVIsToCache オプション 一括コンパイル中にメモリに保持できるVIの数。
メモ VIをキャッシュすると、トップレベルのVIをコンパイルするときにすでにキャッシュされたVIをロードする必要がないため一括コンパイルにかかる実行時間が顕著に縮小されます。ただし、VIのキャッシュによってより多くのシステムメモリが消費されます。複数のサブフォルダに同じ名前のVIが含まれているフォルダを一括コンパイルし、それらのVIがライブラリに属していない場合、VIキャッシュでクロスリンクが発生する可能性があります。
0
-ReloadLVSBs オプション VIのCINを無視し、アプリケーションがそれらを検索できるようにするかどうかを指定するブール値です。

この引数は、多数のCINが再コンパイルされたために再ロードが必要な場合に便利です。

false

MassCompileをLabVIEW用CLIで実行するには、次の構文を使用してコマンドを実行します。

LabVIEWCLI -OperationName MassCompile -DirectoryToCompile <directory of file(s)> -MassCompileLogFile <path to log file> -AppendToMassCompileLog <true or false> -NumOfVIsToCache <number of VIs to cache> -ReloadLVSBs <true or false>

以下に例を示します。

LabVIEWCLI -OperationName MassCompile -DirectoryToCompile "C:\temp" -MassCompileLogFile "C:\temp\log.txt" -AppendToMassCompileLog true -NumOfVIsToCache 0 -ReloadLVSBs false

ExecuteBuildSpec

指定されたビルド仕様の設定を使用してアプリケーションまたはライブラリをビルドし、出力ファイルのパスを返します。

表 26. ExecuteBuildSpec引数は、この操作で使用可能な引数を示しています。

表 26. ExecuteBuildSpec引数
引数 必須またはオプション 説明 デフォルト
-ProjectPath 必須 ビルド仕様が含まれているLabVIEWプロジェクト (.lvproj) ファイルのパス。
-TargetName オプション ビルド仕様が含まれているターゲット。 マイ コンピュータ
-BuildSpecName オプション プロジェクトエクスプローラウィンドウのビルド仕様の下に表示されるビルド仕様の名前。 空の文字列: LabVIEW用CLIは、指定されたターゲットの下にあるすべてのビルド仕様をビルドします。
-BuildDirectory 任意 ビルド出力ファイルを配置するディレクトリのパスです。指定された場合、ビルド出力はビルド仕様で定義された出力先ではなくこの場所に出力されます。-TargetName-BuildSpecNameの両方を指定する必要があります。 ビルド仕様で定義された出力先パス。

この操作をLabVIEW用CLIで実行するには、次の構文を使用してコマンドを実行します。

LabVIEWCLI -OperationName ExecuteBuildSpec -ProjectPath <path to project> -TargetName <name of target> -BuildSpecName <name of build specification> -BuildDirectory <path to output directory>

以下に例を示します。

LabVIEWCLI -OperationName ExecuteBuildSpec -ProjectPath "C:\temp\test.lvproj" -TargetName "My Computer" -BuildSpecName "My DLL" -BuildDirectory "C:\builds\output"
-BuildDirectory引数を使用する際は、以下の点を考慮してください。
  • -BuildDirectory引数を使用しても、アプリケーションまたはライブラリのビルド先を変更しても、ビルド仕様が完全に変更されることはありません。
  • -BuildDirectoryを使用するには、-TargetName-BuildSpecNameの両方を指定する必要があります。いずれかの引数が見つからない場合、LabVIEWCLIはエラーを返します。
  • -BuildDirectory引数は、出力先ディレクトリサポートディレクトリのパスのみをオーバーライドします。-BuildDirectoryを使用しても、ビルド仕様で定義されたカスタムディレクトリには影響しません。
  • -BuildDirectory引数は、アプリケーション (EXE)、DLL、ソース配布、.NET Interopアセンブリ、パックプロジェクトライブラリ、ZIP、インストーラ、およびパッケージ (NIPKG/IPK) ビルド仕様に適用されます。
  • -BuildDirectory引数はFPGAビルド仕様をサポートしていません。

RunVI

次のコネクタペーンインタフェースでVIを実行し、出力またはエラー情報を返します。

3つの端子を持つLabVIEW VIコネクタペーン。

端子 データタイプ 説明

LabVIEW VIコネクタペーンの最初の端子コールアウト。

文字列制御器

文字列データタイプを表すLabVIEW制御器端子。

VIのコマンドライン引数。

LabVIEW VIコネクタペーンの2番目の端子コールアウト。

32ビット符号付き表示器

32ビット符号付き整数データタイプを表すLabVIEW制御器端子。

VIが返すLabVIEW用CLI終了コード。

LabVIEW VIコネクタペーンの3番目の端子コールアウト。

文字列表示器

文字列データタイプを表すLabVIEW制御器端子。

LabVIEW用CLIコンソールまたはログファイルに入れる出力またはエラー情報。

表 27. RunVI引数は、この操作で使用可能な引数を示しています。

表 27. RunVI引数
引数 必須またはオプション 説明 デフォルト
-VIPath 必須 LabVIEWで実行するVIのパス。VIのコネクタペーンが定義済みのインタフェースと一致しない場合、LabVIEW用CLIはエラーを返します。
<VIのコマンドライン引数> オプション VIの入力配列の要素。要素を区切るにはスペースを使用します。

この操作をLabVIEW用CLIで実行するには、次の構文を使用してコマンドを実行します。

LabVIEWCLI -OperationName RunVI -VIPath <VI path> <first element of array> <second element of array>...

以下に例を示します。

LabVIEWCLI -OperationName RunVI -VIPath "C:\Users\inlabview.APAC\Documents\DemoProject\RunVI.vi" 101 202

CloseLabVIEW

プロンプトなしでLabVIEWを閉じます。

メモ VIが開いた状態でこの操作を実行すると、未保存の変更はすべて失われます。この操作を実行する前に、すべての変更を保存してください。

この操作には引数はありません。

この操作をLabVIEW用CLIで実行するには、次のコマンドを実行します。

LabVIEWCLI -OperationName CloseLabVIEW

CreateComparisonReport

指定した2つのVIを比較し、比較操作の結果を含むHTML、XML、Word、またはテキストレポートを出力します。

表 28. CreateComparisonReport引数は、この操作で使用可能な引数を示しています。
表 28. CreateComparisonReport引数
引数 必須またはオプション 説明 デフォルト
-vi1 必須 比較している最初のVIの名前またはパス。
-vi2 必須 比較している2番目のVIの名前またはパス。
-reportType オプション 出力レポートの必要なファイルタイプ。この引数は、以下の値をサポートします。
  • HTML: 外部画像とスタイルファイルを含むHTML形式のレポートを生成します。
  • HTMLSingleFile: 画像とスタイル定義が埋め込まれたHTMLフォームレポートを生成します。
  • MicrosoftWord: Microsoft Word形式のレポートを生成します。
    メモ このオプションを使用するには、Microsoft Wordがお使いのコンピュータにインストールされている必要があります。
  • PlainText: レポートをプレーンテキストで生成します。
  • XML: 外部画像を含むXML形式のレポートを生成します。

この引数を指定しない場合、-reportPathに指定した値から推測されます。

HTMLSingleFile
-reportPath 必須 出力レポートの名前またはパスです。
-o オプション 指定したレポートディレクトリに既存のレポートやサポートファイルがある場合、それらを上書きします。
-c オプション 指定したレポートパスにディレクトリが存在しない場合は、新しいディレクトリを作成します。
-nofp オプション 比較レポートからフロントパネルの差異を除外します。
-nofppos オプション 比較レポートからフロントパネルの位置の差異を除外します。
-nobd オプション 比較レポートからブロックダイアグラムの差異を除外します。
-nobdcosm オプション 比較レポートからブロックダイアグラムの外観の差異を除外します。
-noattr オプション 比較レポートからVI属性の差異を除外します。
-d オプション 依存関係を含めずに、指定したVIを比較します。

vi1vi2には任意のVIを選択できます。vi1は必ずしもベースファイルである必要はなく、vi2は必ずしもベースファイルの変更である必要はありません。比較レポートの範囲:

  • vi1は初期状態に割り当てるVI(vi1の状態から)
  • vi2は後の状態 (vi2の状態へ) に割り当てるVI

この操作をLabVIEW用CLIで実行するには、次の構文を使用してコマンドを実行します。

LabVIEWCLI -OperationName CreateComparisonReport -vi1 <name or path of first VI> -vi2 <name or path of second VI> -reportType <file type of report> -reportPath <name or path of output report>

以下に例を示します。

LabVIEWCLI -OperationName CreateComparisonReport -vi1 "firstVI.vi" -vi2 "secondVI.vi" -reportType "HTMLSingleFile" -reportPath "report.html"

RunVIAnalyzer

LabVIEW VI Analyzerツールキットで指定されたVI Analyzerタスクを実行し、指定された場所にテストレポートを保存します。

表 29. RunVIAnalyzer引数は、この操作で使用可能な引数を示しています。

表 29. RunVIAnalyzer引数
引数 必須またはオプション 説明 デフォルト
-ConfigPath 必須 解析に使用するVI Analyzerタスク設定が含まれている構成ファイルのパス。VI AnalyzerまたはVI Analyzer VIを使用して保存した構成ファイルを使用できます。または、VI、フォルダ、またはLLBを指定して解析を行うこともできます。構成ファイル以外の項目を指定すると、VIは、その指定された項目に対してすべてのVI Analyzerテストを行います。
-ReportPath 必須 レポートファイルのパス。
-ConfigPassword オプション 構成ファイル (存在する場合) のパスワード。 空の文字列
-ReportSaveType オプション レポートまたは結果ファイルの形式。この引数の値は、次のいずれかでなくてはなりません。
  • ASCII
  • HTML
  • RSLファイル
ASCII
-ResultsPath 必須 結果ファイルのパス。パス文字列が空の場合、LabVIEWはこの引数を無視します。
メモ この引数では大文字と小文字が区別されます。

この操作をLabVIEW用CLIで実行するには、次の構文を使用してコマンドを実行します。

LabVIEWCLI -OperationName RunVIAnalyzer -ConfigPath <path to configuration file> -ReportPath <path to report> -ReportSaveType <file type of report> -ConfigPassword <password of configuration file>

以下に例を示します。

LabVIEWCLI -OperationName RunVIAnalyzer -ConfigPath "C:\temp\test.viancfg" -ReportPath "C:\temp\output.html" -ReportSaveType "HTML" -ConfigPassword "abc"

RunUnitTests

LabVIEW Unit Test Frameworkツールキットで指定されたファイルに対してテストを実行し、指定された場所にJUnitファイルを保存します。

メモ この操作を実行するには、JKI VI Package Manager (VIPM) ソフトウェアを使用してUTF JUnit Reportライブラリをインストールする必要があります。

表 30. RunUnitTests引数は、この操作で使用可能な引数を示しています。

表 30. RunUnitTests引数
引数 必須またはオプション 説明 デフォルト
-ProjectPath 必須 プロジェクトファイルのパスです。
-JUnitReportPath 必須 JUnitファイルを出力するパスです。

この操作をLabVIEW用CLIで実行するには、次の構文を使用してコマンドを実行します。

LabVIEWCLI -OperationName RunUnitTests -ProjectPath <path to project file> -JUnitReportPath <path to output JUnit file>
以下に例を示します。
LabVIEWCLI -OperationName RunUnitTests -ProjectPath "C:\temp\test.lvproj" -JUnitReportPath "C:\temp\test.xml"