# sys.volume 库模块帮助文档

## sys.volume 成员列表 <a id="sys.volume" href="#sys.volume">&#x23;</a>

存储卷相关函数。  
相关库：fsys.drives, sys.storage

### sys.volume.deviceDefine(文件路径) <a id="sys.volume.deviceDefine" href="#sys.volume.deviceDefine">&#x23;</a>
将指定的目录映射为虚拟分区  
成功返回分区路径

### sys.volume.deviceDefine(文件路径,"Z:") <a id="sys.volume.deviceDefine" href="#sys.volume.deviceDefine">&#x23;</a>
将指定的目录映射为虚拟分区  
成功返回分区路径

### sys.volume.deviceRemove("字符串参数") <a id="sys.volume.deviceRemove" href="#sys.volume.deviceRemove">&#x23;</a>
移除分区

### sys.volume.getAllDevice() <a id="sys.volume.getAllDevice" href="#sys.volume.getAllDevice">&#x23;</a>
返回所有设备名

### sys.volume.getDeviceName(文件路径) <a id="sys.volume.getDeviceName" href="#sys.volume.getDeviceName">&#x23;</a>
文件路径转换为设备名

### sys.volume.getDriveType(驱动器路径) <a id="sys.volume.getDriveType" href="#sys.volume.getDriveType">&#x23;</a>
返回驱动器类型  
以_DRIVE_为前缀的常量表示不同类型

### sys.volume.getFreeDrive() <a id="sys.volume.getFreeDrive" href="#sys.volume.getFreeDrive">&#x23;</a>
获取未使用的盘符（自"C:"开始）  
这个函数实际指向 fsys.drives.free 函数

### sys.volume.getInfo() <a id="sys.volume.getInfo" href="#sys.volume.getInfo">&#x23;</a>
[返回对象:volumeinfoObject](#volumeinfoObject)

### sys.volume.getInfo(分区或完整路径) <a id="sys.volume.getInfo" href="#sys.volume.getInfo">&#x23;</a>
返回分区信息,  
参数可指定盘符或完整文件路径  
盘符可带冒号也可以不带

### sys.volume.getLogicalDrives() <a id="sys.volume.getLogicalDrives" href="#sys.volume.getLogicalDrives">&#x23;</a>
返回一个包含所可用的逻辑分区盘符的数组,  
盘符以冒号结束  

这个函数实际指向 fsys.drives.get

### sys.volume.getPathName(设备名) <a id="sys.volume.getPathName" href="#sys.volume.getPathName">&#x23;</a>
设备名转换为文件路径

### sys.volume.getSpaceSize("C:\") <a id="sys.volume.getSpaceSize" href="#sys.volume.getSpaceSize">&#x23;</a>
获取分区空间大小, 剩余大小等信息。  
参数指定该分区根目录或者分区内其他有效的目录路径，默认值为当前目录。  
返回对象可用 tostring 或连接操作符转换为字符串，格式为："分区大小（使用百分比）"。

### sys.volume.getSpaceSize() <a id="sys.volume.getSpaceSize" href="#sys.volume.getSpaceSize">&#x23;</a>
[返回对象:valuespacesizeObject](#valuespacesizeObject)

### sys.volume.maxSpace(子目录路径) <a id="sys.volume.maxSpace" href="#sys.volume.maxSpace">&#x23;</a>
将指定的子目录路径转换为空间最大的分区下的完整路径。  
返回转换后的路径

### sys.volume.setLabel("字符串参数","卷标") <a id="sys.volume.setLabel" href="#sys.volume.setLabel">&#x23;</a>
设置区分卷标

## valuespacesizeObject 成员列表 <a id="valuespacesizeObject" href="#valuespacesizeObject">&#x23;</a>

### valuespacesizeObject.availablePercentage <a id="valuespacesizeObject.availablePercentage" href="#valuespacesizeObject.availablePercentage">&#x23;</a>
有效空间百分比

### valuespacesizeObject.avaliableSize <a id="valuespacesizeObject.avaliableSize" href="#valuespacesizeObject.avaliableSize">&#x23;</a>
剩余有效空间大小。  
返回值为 math.size64 对象  

[返回对象:mathSize64Object](https://www.aardio.com/zh-cn/doc/library-reference/math/_.html#mathSize64Object)

剩余有效空间大小。  
返回值为格式化后的字符串（如 "200 GB"）

### valuespacesizeObject.freePercentage <a id="valuespacesizeObject.freePercentage" href="#valuespacesizeObject.freePercentage">&#x23;</a>
剩余空间百分比

### valuespacesizeObject.freeSize <a id="valuespacesizeObject.freeSize" href="#valuespacesizeObject.freeSize">&#x23;</a>
剩余空间大小。  
返回值为 math.size64 对象  

[返回对象:mathSize64Object](https://www.aardio.com/zh-cn/doc/library-reference/math/_.html#mathSize64Object)

剩余空间大小。  
返回值为格式化后的字符串（如 "200 GB"）

### valuespacesizeObject.totalSize <a id="valuespacesizeObject.totalSize" href="#valuespacesizeObject.totalSize">&#x23;</a>
总大小。  
返回值为 math.size64 对象  

[返回对象:mathSize64Object](https://www.aardio.com/zh-cn/doc/library-reference/math/_.html#mathSize64Object)

总大小。  
返回值为格式化后的字符串（如 "200 GB"）

## volumeinfoObject 成员列表 <a id="volumeinfoObject" href="#volumeinfoObject">&#x23;</a>

### volumeinfoObject.drive <a id="volumeinfoObject.drive" href="#volumeinfoObject.drive">&#x23;</a>
分区路径

### volumeinfoObject.flag <a id="volumeinfoObject.flag" href="#volumeinfoObject.flag">&#x23;</a>
标志位

### volumeinfoObject.fsys <a id="volumeinfoObject.fsys" href="#volumeinfoObject.fsys">&#x23;</a>
文件系统

### volumeinfoObject.label <a id="volumeinfoObject.label" href="#volumeinfoObject.label">&#x23;</a>
卷名

### volumeinfoObject.maxlen <a id="volumeinfoObject.maxlen" href="#volumeinfoObject.maxlen">&#x23;</a>
文件路径最大长度

### volumeinfoObject.serial <a id="volumeinfoObject.serial" href="#volumeinfoObject.serial">&#x23;</a>
序列号

### volumeinfoObject.serialNum <a id="volumeinfoObject.serialNum" href="#volumeinfoObject.serialNum">&#x23;</a>
序列号(数值)
