Downloads a file to target path.
Namespace:
Aras.IOM
Assembly:
IOM (in IOM.dll) Version: 11.0.0.6296
Syntax
C# |
---|
public Item fetchFileProperty(
string propertyName,
string targetPath,
FetchFileMode mode
) |
Visual Basic (Declaration) |
---|
Public Function fetchFileProperty ( _
propertyName As String, _
targetPath As String, _
mode As FetchFileMode _
) As Item |
J# |
---|
public Item fetchFileProperty(
String propertyName,
String targetPath,
FetchFileMode mode
) |
JScript |
---|
public function fetchFileProperty(
propertyName : String,
targetPath : String,
mode : FetchFileMode
) : Item |
Parameters
- propertyName
- Type: System..::.String
Name of property of type File for which physical file needs to be downloaded
- targetPath
- Type: System..::.String
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.IOM..::.FetchFileMode
Responsible for reflecting in which mode operation should be completed.
Return Value
Item of type File. Property "checkedout_path" of item will be populated by the path to which file was downloaded.
Exceptions
Exception | Condition |
---|
System..::.ArgumentNullException |
-
Agrument "propertyName" is null or empty.
-
Agrument "targetPath" is null or empty.
|
System..::.ArgumentException |
-
Agrument "mode" is not a part of FetchFileMode enumeration.
|
See Also