Share

iLogicVaultClass.GetFileByFullFilePath Method (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.

Namespace:  Autodesk.iLogic.Vault
Assembly:  Autodesk.iLogic.Vault (in Autodesk.iLogic.Vault.dll) Version: 30.0

Syntax

VB

Public Function GetFileByFullFilePath ( 
	VaultFullFileName As String,
	ByRef VaultFileProperties As Dictionary(Of String, String),
	ByRef VaultItemProperties As Dictionary(Of String, String),
	Optional CheckOut As Boolean = false
) As String

C#

public string GetFileByFullFilePath(
	string VaultFullFileName,
	ref Dictionary<string, string> VaultFileProperties,
	ref Dictionary<string, string> VaultItemProperties,
	bool CheckOut = false
)

Parameters

VaultFullFileName
Type: System.String
The full path and file name in Vault virtual folder structure, e.g., "$/Designs/Part1.ipt"
VaultFileProperties
Type: System.Collections.Generic.Dictionary(String, String)
pairs of Vault File property display name and property value
VaultItemProperties
Type: System.Collections.Generic.Dictionary(String, String)
pairs of Vault Item property display name and property value
CheckOut (Optional)
Type: System.Boolean

Return Value

Type: String
Local path/filename

See Also

Reference

Was this information helpful?