ItemfetchFileProperty Method |
Downloads a file to target path.
Namespace:
Aras.IOM
Assembly:
IOM (in IOM.dll) Version: 14.0.9.36244
Syntaxpublic Item fetchFileProperty(
string propertyName,
string targetPath,
FetchFileMode mode
)
Public Function fetchFileProperty (
propertyName As String,
targetPath As String,
mode As FetchFileMode
) As Item
public Item fetchFileProperty(
String propertyName,
String targetPath,
FetchFileMode mode
)
public function fetchFileProperty(
propertyName : String,
targetPath : String,
mode : FetchFileMode
) : Item
Parameters
- propertyName
- Type: SystemString
Name of property of type File for which physical file needs to be downloaded - targetPath
- Type: SystemString
Path to folder or file to which physical file should be downloaded. Here is examples of possible values:
- Folder path, example: C:/temp/
- Full file path, example: C:/temp/1.txt
- mode
- Type: Aras.IOMFetchFileMode
Responsible for reflecting in which mode operation should be completed.
Return Value
Type:
ItemItem of type File. Property "checkedout_path" of item will be populated by the path to which file was downloaded.
ExceptionsException | Condition |
---|
ArgumentNullException | -
Agrument "propertyName" is null or empty.
-
Agrument "targetPath" is null or empty.
|
ArgumentException | -
Agrument "mode" is not a part of FetchFileMode enumeration.
|
See Also