AddFileToAcquire(FileIteration,AcquisitionOption,FilePathAbsolute) Method
Adds a file to the list of entities to be acquired.
Syntax
public void AddFileToAcquire(
FileIteration file,
AcquireFilesSettings.AcquisitionOption acquisitionOption,
FilePathAbsolute downloadPath
)Public Overloads Sub AddFileToAcquire( _
ByVal file As FileIteration, _
ByVal acquisitionOption As AcquireFilesSettings.AcquisitionOption, _
ByVal downloadPath As FilePathAbsolute _
) Parameters
| Name | Description |
|---|---|
| file | The file to be acquired |
| acquisitionOption | Whether the file should be downloaded, checked out, or both |
| downloadPath | The location where the file should be downloaded. If null, then it will be downloaded to it's working folder |
Remarks
The generic AddEntityToAcquire method could be called instead of this, but this method allows for additional file-specific configuration to be specified. The file-specific configuration is associated with the file master. Therefore, if the specific iteration of the file being added is changed during the acquisition due to relationship gathering options, the acquired file will still attempt to use the configuration specified when adding it do the download set.