Provides functions to query, download, and check out files from Vault.
It also has a function to add files (with limitations), and another function to update properties.
It also has a function to add files (with limitations), and another function to update properties.
In a rule, this class is instantiated by the predefined object named iLogicVault.
Note: these functions will only work if the Vault add-in is loaded. Vault Basic is not supported.
Inheritance Hierarchy
System.ObjectAutodesk.iLogic.Vault.iLogicVaultClass
Namespace: Autodesk.iLogic.Vault
Assembly: Autodesk.iLogic.Vault (in Autodesk.iLogic.Vault.dll) Version: 30.0
Syntax
VB
Public NotInheritable Class iLogicVaultClass
C#
public sealed class iLogicVaultClass
The iLogicVaultClass type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | iLogicVaultClass |
Properties
| Name | Description | |
|---|---|---|
 | IsVaultBasic |
Returns True if we are running on Vault Basic.
|
| IsVaultPro |
Returns True if we are running on Vault Pro.
|
| LoggedIn |
Property representing the current user's Vault connection state. Returns true if the current user is logged in.
|
Methods
| Name | Description | |
|---|---|---|
| AddFile |
Adds local file to Vault and optionally attaches it to a parent file. Does NOT build parent-child relationships! So this function should not be used on any file (e.g. an assembly or drawing) that contains references to other files. |
| CheckFilesExistBySearchCriteria(Dictionary(String, String), Boolean, String[]) |
Search for multiple file(s) by one to many search criteria (specified as property/value pairs). Returns a list of file names found, matching the criteria. Preset Search Operator Options: [Property] is (exactly) [Value]; multiple conditions link up using AND/OR condition, depending MatchAllCriteria = True/False |
| CheckFilesExistBySearchCriteria(Dictionary(String, String), Dictionary(String, Dictionary(String, String)) , Boolean, String[]) |
Search multiple file(s) by one to many search criteria as property/value pairs. Returns list of file names found, matching the criteria. Preset Search Operator Options: [Property] is (exactly) [Value]; multiple conditions link up using AND/OR condition, depending MatchAllCriteria = True/False |
| ConvertLocalPathToVaultPath |
Convert the local file or folder path to the corresponding folder path in Vault.
|
| CopyLocalFile |
Copies a local file to a new name. The source file's location and extension are captured and applied to the copy. Use Check-In (iLogic) command for adding the new file to Vault. |
| GetFileByFullFilePath(String, Boolean) |
Downloads Vault file using full file path, e.g. "$/Designs/Base.ipt". Returns full file name in local working folder. Children and attachments are also downloaded. |
| GetFileByFullFilePath(String, Dictionary(String, String) , Boolean) |
Downloads Vault file using full file path, e.g. "$/Designs/Base.ipt". Returns full file name in local working folder. Children and attachments are also downloaded. File Properties return all values converted to text. Access the value using the Vault property display name as key. |
| GetFileByFullFilePath(String, Dictionary(String, String) , Dictionary(String, String) , Boolean) |
Downloads Vault file using full file path, e.g. "$/Designs/Base.ipt". Returns full file name in local working folder,
download options include children and attachments. File and Item property dictionaries return all values converted to text. Access the value using the Vault property display name as key. |
| GetFileBySearchCriteria(Dictionary(String, String), Boolean, Boolean, String[]) |
Search for a file by one to many search criteria as property/value pairs. Downloads the first file found, if the search result lists more than a single file. Dependents and attachments are included. Overwrites existing files. Preset Search Operator Options: [Property] is (exactly) [Value]; multiple conditions link up using AND/OR condition, depending MatchAllCriteria = True/False Returns the file name downloaded (does not return names of downloaded children and attachments). |
| GetFileBySearchCriteria(Dictionary(String, String), Dictionary(String, String) , Boolean, Boolean, String[]) |
Search for a file by one to many search criteria as property/value pairs. Downloads the first file found, if the search result lists more than a single file. Dependents and attachments are included. Overwrites existing files. Preset Search Operator Options: [Property] is (exactly) [Value]; multiple conditions link up using AND/OR condition, depending MatchAllCriteria = True/False Returns the file name downloaded (does not return names of downloaded children and attachments). File property dictionaries return all values converted to text. Access the value using the Vault property display name as key. |
| GetFileBySearchCriteria(Dictionary(String, String), Dictionary(String, String) , Dictionary(String, String) , Boolean, Boolean, String[]) |
Search for a file by 1 to many search criteria as property/value pairs. Downloads the first file found, if the search result lists more than a single file. Dependents and attachments are included. Overwrites existing files. Preset Search Operator Options: [Property] is (exactly) [Value]; multiple conditions link up using AND/OR condition, depending MatchAllCriteria = True/False Returns the file name downloaded (does not return names of downloaded children and attachments). File and Item property dictionaries return all values converted to text. Access the value using the Vault property display name as key. |
| GetFileCopyBySourceFileNameAndAutoNumber |
Copy Vault file on file server and download using full file path, e.g. "$/Designs/Base.ipt". Create new file name using default or named numbering scheme. Preset Options: Download Children (recursively) = Enabled, Enforce Overwrite = True |
| GetFileCopyBySourceFileNameAndNewName |
Copy Vault file on file server and download using full file path, e.g. "$/Designs/Base.ipt". Create new file name re-using source file's extension and new file name variable. Preset Options: Download Children (recursively) = Enabled, Enforce Overwrite = True |
| GetFileCopyBySourceFileSearchAndAutoNumber |
Search multiple file(s) by 1 to many search criteria as property/value pairs. Downloads first file matching all or any search criteria. Preset Search Operator Options: [Property] is (exactly) [Value]; multiple conditions link up using AND condition. Preset Download Options: Download Children (recursively) = Enabled, Enforce Overwrite = True |
| GetFileCopyBySourceFileSearchAndNewName |
Search multiple file(s) by 1 to many search criteria as property/value pairs. Downloads first file matching all or any search criteria. Preset Search Operator Options: [Property] is (exactly) [Value]; multiple conditions link up using AND condition. Preset Download Options: Download Children (recursively) = Enabled, Enforce Overwrite = True |
| GetFilesBySearchCriteria |
Search for multiple files by 1 to many search criteria as property/value pairs. Downloads all files found, matching the criteria. Dependents and attachments are included. Overwrites existing files. Preset Search Operator Options: [Property] is (exactly) [Value]; multiple conditions link up using AND/OR condition, depending MatchAllCriteria = True/False Returns list of files names downloaded (does not return names of downloaded children and attachments). |
| GetNewNumber |
Create single file number by scheme name and optional input parameters.
|
| GetThumbnailFileByFullSourceFilePath |
Download Thumbnail Image of the given file as Image file.
|
| GetThumbnailFileBySearchCriteria |
Download Thumbnail Image of the file searched as Image file.
|
| GetThumbnailImageByFullSourceFilePath |
Get Thumbnail of the given file as Image object.
|
| GetThumbnailImageBySearchCriteria |
Get Thumbnail Image of the file searched as Image object.
|
| GetVaultConnection |
Deprecated. Returns current Vault connection. Leverage LoggedIn property whenever possible.
Null value returned if user is not logged in.
|
| GetVaultFileStatus |
Get the local file's status in Vault. Validate the ErrorState = "None" to get all return values for vaulted files. Validate the ErrorState = (LocalFileNotFoundVaultFileNotFound|VaultFileNotFound) to validate files before first time check-in |
| UpdateVaultFileProperties |
Update multiple Vault file properties.
|