Vault 操作 <VaultOperation>

概要

VaultOperation は、すべての Vault のチェックアウト、ダウンロード、チェックイン、およびステータスのクエリーを処理します。VaultOperation は通常、VaultConnection の子です。

Mixin

VaultOperationMixin

LightweightPart

AssemblyMixin

[パラメータ]

Name [タイプ] 説明
Connection パーツ VaultConnection パーツです。既定は Parent です。
RefreshVaultAddin? boolean True の場合(既定値)、Inventor Vault アドインのステータスは、操作後に最新の状態にするために、チェックインまたはチェックアウト操作後に更新されます。
LocalFiles list 操作のためのローカル ファイル名の一覧です。
CheckInComment 文字列 チェックイン コメントです。既定では、Inventor ETO によるチェックインに設定されます。VaultCheckInOperationMixin から
GenerateDwf? boolean True の場合、チェックインの最上位の Inventor ファイルのための DWF ファイルが作成されます。既定値は False です。VaultCheckInOperationMixin から
GenerateDwfWithJobServer? boolean True の場合、DWF の生成がローカル コンピュータの代わりにチェックインする直前に Vault ジョブ サーバのジョブとしてスケジュールされます。GenerateDwf? も True にする必要があります。Vault Explorer を使用して、ジョブ サーバとジョブ プロセッサを有効にします。OOnly は、Vault Workgroup、Collaboration、または Professional エディションで使用できます。既定は False です。VaultCheckInOperationMixin から
GenerateDwfForAllFiles? boolean True の場合、チェックインの最上位のすべての子に対する DWF ファイルが作成されます。既定値は False です。GenerateDwf? も True にする必要があります。VaultCheckInOperationMixin から
CheckOutComment 文字列 チェックアウト コメントです。既定では、Inventor ETO によるチェックアウトに設定されます。VaultCheckOutOperationMixin から
DownloadLatestChildrenOnCheckIn? boolean Inventor ファイルにチェックインする前に子のファイルの最新バージョンがダウンロードされていることを確認する場合は、True に設定します。詳細については、VaultInventorFilesDownloadLatest メソッドを参照してください。VaultCheckOutOperationMixin から

ルール

Name [タイプ] 説明
テスト list 指定されたパラメータを使用して、Vault 操作を記述する一覧を返すことによって、Vault 操作をテストします。

メソッド

FilesExistInVault( localFileNames As List, Optional exceptionOnError? As Boolean = True) As List

長さが localFileNames list 引数に等しい一覧を返します。ファイルが存在する場合は返されるリストに True の値が記述され、そうでない場合は False が記述されます。またオプションの ExceptionOnError? が False の場合、エラー時に NoValue が記述されます。位置は localFileNames 一覧内の各ファイル名の位置に対応します。

VaultFilesCheckedOutStatus( localFileNames As List, Optional exceptionOnError? As Boolean = True) As List

一覧の一覧の長さが localFileNames list 引数に等しい場合、各内部一覧は localFileNames list 引数のファイルに対応します。ファイルがチェックアウトしている場合、内部一覧にチェックアウト ステータス詳細が記述されます。ファイルがチェックアウトしていない場合、内部一覧は空({})です。エラーがある場合、オプションの exceptionOnError? 引数が False になり、内部一覧に NoValue が記述されます。

VaultFileCheckedOutStatus( localFileName As String, Optional exceptionOnError? As Boolean = True) As List

上記の VaultFilesCheckedOutStatus()と同じように、VaultFileCheckedOutStatus()は引数として 1 つのファイルを使用し、上述の内部一覧のようなチェックアウト ステータスを返します。

VaultFilesIsLatestStatus( localFileNames As List, Optional exceptionOnError? As Boolean = True) As List

長さが localFileNames list 引数に等しい一覧を返します。ローカル ファイルが最新バージョンである場合は返されるリストに True の値が記述され、そうでない場合は False が記述されます。またオプションの ExceptionOnError? が False の場合、エラー時に NoValue が記述されます。位置は localFileNames list 内の各ファイル名の位置に対応します。

VaultFilesDownloadLatest( localFileNames As List, Optional exceptionOnError? As Boolean = True) As List 

localFileNames list 引数の各ファイルの最新バージョンをダウンロードし、ダウンロード操作が正常に終了したことの確認が完了したら VaultFilesIsLatestStatus を返します。

VaultFilesCheckIn( localFileNames As List, Optional refreshVaultAddin? As Boolean = True, Optional exceptionOnError? As Boolean = True) As List

localFileNames list 引数のファイルをチェックインし、チェックインを確認するファイルごとのステータス情報の一覧を返します。一覧内の各要素は、Autodesk.Intent.Vault.CheckinResult タイプ(またはエラーが発生した場合は NoValue)です。詳細については、API マニュアルを参照してください。CheckIn ルールには、CheckinResult を Intent 値のみが記述された一覧に変換するコードが含まれています。

VaultFilesCheckOut( localFileNames As List, Optional refreshVaultAddin? As Boolean = True, Optional exceptionOnError? As Boolean = True) As List

localFileNames list 引数のファイルをチェックアウトし、チェックアウトを確認するファイルごとのステータス情報の一覧を返します。返される一覧の詳細については、VaultFilesCheckedOutStatus メソッドを参照してください。

GetVaultPathNames( workingFileNames As List, Optional exceptionOnError? As Boolean = True) As List

workingFileNames list 引数に対応する Vault のパス名の一覧を返します。

GetWorkingPathNames( vaultFileNames As List, Optional exceptionOnError? As Boolean = True) As List

vaulrFileNames list 引数に対応するファイルのパス名の一覧を返します。

VaultFindFiles( workingFileNames As List, Optional exceptionOnError? As Boolean = True) As List

workingFileNames list 引数に対応する Vault のパス名の一覧を返します。workingFileNames 一覧には、パス(フォルダ情報)は記述されず、ファイルの名前のみが記述されます。

VaultGetFilesProperties( localFileNames As List, Optional exceptionOnError? As Boolean = True) As List

各内部一覧に localFileNames list 引数内の各ローカル ファイル名の Vault ファイル プロパティが記述されたリストの一覧を返します。

VaultQueryMetaData( workingFileNames As List, Optional exceptionOnError? As Boolean = True) As List

内部一覧に workingFileNames list 引数内の作業ファイルに対応するメタデータが記述されたリストの一覧を返します。

VaultFindFilesNotAtLatestVersion( localFileNames As List, Optional exceptionOnError? As Boolean = True) As List

一覧内の各ローカル ファイル名を最新バージョンであるかどうかチェックし、最新バージョンでないファイルの一覧を返します。

VaultInventorFilesDownloadLatest( topLevelFileName As String, localChildFileNames As List, Optional exceptionOnError? As Boolean = True) As Any

これは、Inventor(または Inventor Server)でのみ動作します。これは vault から localChildFileNames の最新バージョンをダウンロードします。現在ロードされている Inventor ドキュメントが更新され、Vault からバージョンで現在のバージョンを置き換えます。最上位のドキュメント(および、その他の変更されたドキュメント)が自動的に更新および保存されます。通常、VaultFindFilesNotAtLatestVersion メソッドから localChildFileNames 一覧を取得します。この一覧内のファイルは、topLevelFileName ファイルの下にある子(コンポーネントやその他の関連ファイル)である必要があります。Intent モデルの場合、このメソッドはメンバ ファイルが Vault からローカルに取得されるのではなく、生成されている場合に最も便利です。モデルが生成されるときに Vault からメンバ ファイルを取得するためのメソッドがデザインに含まれている場合でも、一部のメンバ ファイルは、その時点で Vault で使用できない場合があります。ただし、それらはあとで(おそらくは別のユーザによって) Vault に追加される場合があります。したがってこれらは Vault 内に存在し、ローカルで生成されたファイルは Vault からは順番を無視して編集されたとみなされます。