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).
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).
Namespace: Autodesk.iLogic.Vault
Assembly: Autodesk.iLogic.Vault (in Autodesk.iLogic.Vault.dll) Version: 30.0
Syntax
VB
Public Function GetFileBySearchCriteria ( SearchCriteria As Dictionary(Of String, String), Optional MatchAllCriteria As Boolean = true, Optional CheckOut As Boolean = false, Optional SearchFolders As String() = Nothing ) As String
C#
public string GetFileBySearchCriteria( Dictionary<string, string> SearchCriteria, bool MatchAllCriteria = true, bool CheckOut = false, string[] SearchFolders = null )
Parameters
- SearchCriteria
- Type: System.Collections.Generic.Dictionary(String, String)
Dictionary of property/value pairs - MatchAllCriteria (Optional)
- Type: System.Boolean
Optional. Switches AND/OR conditions using multiple criteria. Default is true - CheckOut (Optional)
- Type: System.Boolean
Optional. File downloaded does NOT check-out as default - SearchFolders (Optional)
- Type: System.String[]
Optional. Limit search scope to given folder path(s).
Return Value
Type: StringLocal path/filename