CrestronFileTransferClientGetFile Method |
Retrieves the remote file pointed by URL.
This method directly uses the URL supplied.
The URL is retrieved to the destination (localPath) file. Port number can be embedded into URL.
Some examples of valid URL prefixed with the specified protocol - http://host.com/myPath/MyFile.txt, https://host.com/myPath/MyFile.txt, ftp://host.com:21/myPath/MyFile.txt, etc.
Namespace: Crestron.SimplSharpAssembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntaxpublic int GetFile(
string url,
string localPath
)
Parameters
- url String
- The URL to the file intended for downloading
- localPath String
- The fully qualified local path to the file being downloaded starting with initial "/"
Return Value
Int32Zero if successful.
-1 if underlying object has not been properly initialized.
1 if internal error occurred. Use GetLastClientError() to retrieve the error code.
87 if invalid parameter was passed.
Exceptions
RemarksNon-ASCII characters are not currently supported.
Version Information
.NET
Supported in: 6.0
.NET Compact Framework
Supported in: 3.5
See Also