【system.folder】使用说明

时间:2021-06-09 10:11:49

对象:system.folder

说明:提供一系列针对文件夹的操作

目录:

方法 返回 说明
system.folder.exists(folderPath) [True | False] 检测指定文件夹是否存在
system.folder.name(folderPath) [Empty | String] 获取文件夹名称
system.folder.reName(folderPath, newName) [True | False] 重命名文件夹
system.folder.size(folderPath) [Number] 获取文件夹大小
system.folder.formatSize(folderPath) [String] 获取文件夹大小数值(单位字节k,文件不存在时返回0)
system.folder.createDate(folderPath) [Empty | Date] 获取文件夹创建日期
system.folder.modifyDate(folderPath) [Empty | Date] 获取文件夹最后修改日期
system.folder.accessDate(folderPath) [Empty | Date] 获取文件夹最后访问日期
system.folder.fileNumber(folderPath) [Number] 获取文件夹下文件数量(文件夹不存在时返回0)
system.folder.subFolderNumber(folderPath) [Number] 获取文件夹下文件夹数量(文件夹不存在时返回0)
system.folder.create(folderPath, createFolderPath) [True | False] 创建文件夹,并返回创建结果
system.folder.copy(folderPath, targetPath, cover) [True | False] 复制整个文件夹(将folderPath这个文件夹复制到targetPath里面,而不是把文件夹的内容复制到targetPath里面)
system.folder.copyContent(folderPath, targetPath, cover) [True | False] 复制内容(将folderPath这个文件夹内的所有内容复制到targetPath里面)
system.folder.copySubFolders(folderPath, targetPath, cover) [True | False] 复制文件夹内所有子文件夹到目标文件夹内
system.folder.copyFiles(folderPath, targetPath, cover) [True | False] 复制文件夹下所有文件(不含子文件夹下的文件)
system.folder.delete(folderPath) [True | False] 删除文件夹(如果文件夹不存在,返回true)
system.folder.clearSubFolders(folderPath) [True | False] 清空所有子文件夹
system.folder.clearFiles(folderPath) [True | False] 清空文件夹内所有文件(不含子文件夹下的文件)
system.folder.clear(folderPath) [True | False] 清空文件夹
system.folder.move(folderPath, targetPath, cover) [True | False] 移动文件夹(将整个文件夹移动到目标路径下)
system.folder.moveContent(folderPath, targetPath, cover) [True | False] 移动文件夹内容(将文件夹下的所有内容移动到目标路径下)
system.folder.moveSubFolders(folderPath, targetPath, cover) [True | False] 将源文件夹内的所有子文件夹,移动到目标文件夹内
system.folder.moveFiles(folderPath, targetPath, cover) [True | False] 将源文件夹内的所有文件
system.folder.subFolderName(folderPath) [Array] 获取当前文件夹下所有子文件夹名称集合,数组的每个元素为子文件夹的相对根目录的路径
system.folder.fileName(folderPath) [Array] 获取当前文件夹下所有子文件名集合,数组的每个元素为文件相对根目录的路径

方法:

函数: system.folder.exists(folderPath)
说明: 检测指定文件夹是否存在
返回: [True | False]
参数:
folderPath [必需 String] 文件夹相对路径
函数: system.folder.name(folderPath)
说明: 获取文件夹名称
返回: [Empty | String]
参数:
folderPath [必需 String] 文件夹相对路径
函数: system.folder.reName(folderPath, newName)
说明: 重命名文件夹
返回: [True | False]
参数:
folderPath [必需 String] 文件夹相对路径
newName [必需 String] 新文件夹名称
函数: system.folder.size(folderPath)
说明: 获取文件夹大小
返回: [Number]
参数:
folderPath [必需 String] 文件夹相对路径
函数: system.folder.formatSize(folderPath)
说明: 获取文件夹大小数值(单位字节k,文件不存在时返回0)
返回: [String]
参数:
folderPath [必需 String] 文件夹相对路径
函数: system.folder.createDate(folderPath)
说明: 获取文件夹创建日期
返回: [Empty | Date]
参数:
folderPath [必需 String] 文件夹相对路径
函数: system.folder.modifyDate(folderPath)
说明: 获取文件夹最后修改日期
返回: [Empty | Date]
参数:
folderPath [必需 String] 文件夹相对路径
函数: system.folder.accessDate(folderPath)
说明: 获取文件夹最后访问日期
返回: [Empty | Date]
参数:
folderPath [必需 String] 文件夹相对路径
函数: system.folder.fileNumber(folderPath)
说明: 获取文件夹下文件数量(文件夹不存在时返回0)
返回: [Number]
参数:
folderPath [必需 String] 文件夹相对路径
函数: system.folder.subFolderNumber(folderPath)
说明: 获取文件夹下文件夹数量(文件夹不存在时返回0)
返回: [Number]
参数:
folderPath [必需 String] 文件夹相对路径
函数: system.folder.create(folderPath, createFolderPath)
说明: 创建文件夹,并返回创建结果
返回: [True | False]
参数:
folderPath [必需 String] 文件夹相对路径
createFolderPath [可选 True | False] 创建模式,默认值false,当值为true时表示路径不存在时创建该路径
函数: system.folder.copy(folderPath, targetPath, cover)
说明: 复制整个文件夹(将folderPath这个文件夹复制到targetPath里面,而不是把文件夹的内容复制到targetPath里面)
返回: [True | False]
参数:
folderPath [必需 String] 文件夹相对路径
targetPath [必需 String] 目标路径,目标路径不存在时尝试创建
cover [可选 Boolean] 是否覆盖已存在的文件夹,默认是false。当前true时同名文件会被覆盖
注意:
1) 空间不足时复制失败,返回false
2) 源文件夹不存在时失败,返回false
3) 目标路径创建失败时,返回false
4) 父文件夹向子文件夹复制时失败,返回false
函数: system.folder.copyContent(folderPath, targetPath, cover)
说明: 复制内容(将folderPath这个文件夹内的所有内容复制到targetPath里面)
返回: [True | False]
参数:
folderPath [必需 String] 文件夹相对路径
targetPath [必需 String] 目标路径,目标路径不存在时尝试创建
cover [可选 Boolean] 是否覆盖已存在的文件夹,默认是false。当前true时同名文件会被覆盖 注意:
1) 空间不足时复制失败,返回false
2) 源文件夹不存在时失败,返回false
3) 目标路径创建失败时,返回false
4) 父文件夹向子文件夹复制时失败,返回false
函数: system.folder.copySubFolders(folderPath, targetPath, cover)
说明: 复制文件夹内所有子文件夹到目标文件夹内
返回: [True | False]
参数:
folderPath [必需 String] 文件夹相对路径
targetPath [必需 String] 目标路径,目标路径不存在时尝试创建该路径
cover [可选 Boolean] 是否覆盖已存在的文件夹,默认是false。当前true时同名文件会被覆盖 注意:
1) 复制失败时,中止继续复制后面的子文件夹,同时不会清除已成功复制的子文件夹。
2) 目标路径无法创建时,复制失败。
函数: system.folder.copyFiles(folderPath, targetPath, cover)
说明: 复制文件夹下所有文件(不含子文件夹下的文件)
返回: [True | False]
参数:
folderPath [必需 String] 文件夹相对路径
targetPath [必需 String] 目标路径,目标路径不存在时尝试创建该路径
cover [可选 Boolean] 是否覆盖已存在的文件,默认是false。当前true时同名文件会被覆盖 注意:
1) 复制失败时,中止继续复制后面的文件,同时不会清除已成功复制的文件。
2) 目标路径无法创建时,复制失败
函数: system.folder.delete(folderPath)
返回: [True | False]
说明: 删除文件夹(如果文件夹不存在,返回true)
参数:
folderPath [必需 String] 文件夹相对路径
函数: system.folder.clearSubFolders(folderPath)
说明: 清空所有子文件夹
返回: [True | False]
参数:
folderPath [必需 String] 文件夹相对路径 注意: 清除子文件夹过程时,如果某一个文件夹删除失败,并不影响继续清除下一个文件夹
函数: system.folder.clearFiles(folderPath)
说明: 清空文件夹内所有文件(不含子文件夹下的文件)
返回: [True | False]
参数:
folderPath [必需 String] 文件夹相对路径 注意: 清除文件过程时,如果某一个文件删除失败,并不影响继续清除下一个文件
函数: system.folder.clear(folderPath)
说明: 清空文件夹
返回: [True | False]
参数:
folderPath [必需 String] 文件夹相对路径 注意: 清空出错时不会中止执行清除队列内的其它文件或文件夹
函数: system.folder.move(folderPath, targetPath, cover)
说明: 移动文件夹(将整个文件夹移动到目标路径下)
返回: [True | False]
参数:
folderPath [必需 String] 文件夹的相对路径
targetPath [必需 String] 目标文件夹相对路径,目标路径不存在时尝试创建路径
cover [可选 Boolean] 是否覆盖已存在的文件夹,默认值false
函数: system.folder.moveContent(folderPath, targetPath, cover)
说明: 移动文件夹内容(将文件夹下的所有内容移动到目标路径下)
返回: [True | False]
参数:
folderPath [必需 String] 文件夹的相对路径
targetPath [必需 String] 目标文件夹相对路径,目标路径不存在时尝试创建路径
cover [可选 Boolean] 是否覆盖已存在的文件夹,默认值false
函数: system.folder.moveSubFolders(folderPath, targetPath, cover)
说明: 将源文件夹内的所有子文件夹,移动到目标文件夹内
返回: [True | False]
参数:
folderPath [必需 String] 文件夹的相对路径
targetPath [必需 String] 目标文件夹相对路径,目标路径不存在时尝试创建路径
cover [可选 Boolean] 是否覆盖已存在的文件夹,默认值false
函数: system.folder.moveFiles(folderPath, targetPath, cover)
说明: 将源文件夹内的所有文件
返回: [True | False]
参数:
folderPath [必需 String] 文件夹的相对路径
targetPath [必需 String] 目标文件夹相对路径,目标路径不存在时尝试创建路径
cover [可选 Boolean] 是否覆盖已存在的文件夹,默认值false
函数: system.folder.subFolderName(folderPath)
说明: 获取当前文件夹下所有子文件夹名称集合,数组的每个元素为子文件夹的相对根目录的路径
返回: [Array]
参数:
folderPath [必需 String] 文件夹的相对路径
函数: system.folder.fileName(folderPath)
说明: 获取当前文件夹下所有子文件名集合,数组的每个元素为文件相对根目录的路径
返回: [Array]
参数:
folderPath [必需 String] 文件夹的相对路径