MqttSyncClientDownloadFileAsync 方法 (String, String, ActionInt64, Int64, String, HslCancelToken) |
[文件引擎] 从远程服务器下载一个文件到本地,需要指定文件类别,文件名,进度报告,本地保存的文件名
[File Engine] To download a file from a remote server to the local, you need to specify the file category, file name, progress report, and file name saved locally
命名空间:
HslCommunication.MQTT
程序集:
HslCommunication (在 HslCommunication.dll 中) 版本:12.1.2.0 (12.1.2.0)
语法 public Task<OperateResult> DownloadFileAsync(
string groups,
string fileName,
Action<long, long> processReport,
string fileSaveName,
HslCancelToken cancelToken = null
)
Public Function DownloadFileAsync (
groups As String,
fileName As String,
processReport As Action(Of Long, Long),
fileSaveName As String,
Optional cancelToken As HslCancelToken = Nothing
) As Task(Of OperateResult)
public:
Task<OperateResult^>^ DownloadFileAsync(
String^ groups,
String^ fileName,
Action<long long, long long>^ processReport,
String^ fileSaveName,
HslCancelToken^ cancelToken = nullptr
)
member DownloadFileAsync :
groups : string *
fileName : string *
processReport : Action<int64, int64> *
fileSaveName : string *
?cancelToken : HslCancelToken
(* Defaults:
let _cancelToken = defaultArg cancelToken null
*)
-> Task<OperateResult>
参数
- groups
- 类型:SystemString
文件的类别,例如 Files/Personal/Admin 按照斜杠来区分 - fileName
- 类型:SystemString
文件名称,例如 123.txt - processReport
- 类型:SystemActionInt64, Int64
进度报告,第一个参数是已完成字节数,第二个参数是总字节数,如果不需要,传入NULL即可 - fileSaveName
- 类型:SystemString
本地保存的文件名 - cancelToken (Optional)
- 类型:HslCommunication.CoreHslCancelToken
取消下载操作的令牌
返回值
类型:
TaskOperateResult是否下载成功
参见