博维云文档


DownFile 【对象函数】

函数说明

下载服务器上传下载目录里的文件到本地(接收下载进度消息需要重载消息接收器, 云端事件函数不存在时默认为禁止下载)

函数原型

DownFile(String server_file_name,String local_file_path,String task_token,boolean bExistFail,boolean bApp,CString out_res)

参    数

• server_file_path [字符串型]:待下载的服务器文件路径(格式:a/1.jpg)
• local_save_name [字符串型]:保存在本地的文件名称(可以包含路径,例子:c:\\a\\b\\a.txt,如果有中间目录则自动创建)
• task_token [字符串型]:任务标识符,用于停止任务和进度信息甄别(建议使用唯一性字符串),为空则不能手动停止任务(长度:0 - 16)
• bExistFail [逻辑型]:true 表示如果本地存在同名文件则下载失败
• bApp [逻辑型]:true 表示发送消息给云应用进行验证,触发云应用函数 _downfile(),如果函数不存在则禁止下载
• out_res [字符串对象]:博维云内置引用对象,接收云应用函数 _downfile() 回传的数据

返回值

 boolean(逻辑型,下载成功返回true,失败返回false) 

示    例

// 以下为java代码
String strServerName = "down_file.txt";
String strLocalPath = Environment.getExternalStorageDirectory().getPath() + "/down_file.txt";
String strTaskToken = "my_down_task";
CString out_res = new CString();
boolean b = m_client.DownFile(strServerName, strLocalPath, instance.strTaskToken, true, true, out_res);
if(b)
    Log.i("down file ok", "recv:"+out_str.toString());
else
    Log.e("down file fail", "err:"+m_client.GetLastError());

输出信息

备    注

错误信息

• 详情请使用 GetLastError() 获取