UpdateFileReferences Method
Updates the files references for a collection of files that are on disk.
Syntax
System.Collections.Generic.IDictionary<FileIteration,IEnumerable<FileReferenceUpdateStatus>> UpdateFileReferences(
UpdateFileReferencesModel updateRefModel,
System.Collections.Generic.IDictionary<FileIteration,FilePathAbsolute> filesAndLocalPaths
)Function UpdateFileReferences( _
ByVal updateRefModel As UpdateFileReferencesModel, _
ByVal filesAndLocalPaths As System.Collections.Generic.IDictionary(Of FileIteration,FilePathAbsolute) _
) As System.Collections.Generic.IDictionary(Of FileIteration,IEnumerable(Of FileReferenceUpdateStatus))Parameters
| Name | Description |
|---|---|
| updateRefModel | The model used to update the files references. |
| filesAndLocalPaths | A map of files to be updated paired with their location on disk. |
Return Value
A collection of file iterations that were attempted to be updated paired with their file reference udpate results.
Remarks
Updating file references is usually part of a file download. This method provides access to the update file references logic for files that need to be updated but are already on disk. It's important to set up the UpdateRefModel corerctly when using this workflow. Be sure that the UpdateRefModel knows about referenced files that are not expected to be in their working folder locations by setting their respective target local paths on the model. More information can be found on the Autodesk.DataManagement.Client.Framework.Vault.Models.UpdateFileReferencesModel class.