# sevenZip.lzma 库模块帮助文档
## sevenZip.lzma 成员列表 #
### sevenZip.lzma.compress() #
[返回对象:SEVERZIPLZMAHEADERObject](#SEVERZIPLZMAHEADERObject)
### sevenZip.lzma.compress(待压缩数据,压缩级别,字典大小,线程数,lc,lp,pb,fb) #
压缩字符串,除参数一以外其他参数可选,
成功返回两个值:lzmaHeaer,lzmaData,
lzmaHeaer为LZMA压缩头,lzmaData为压缩后字符串
失败返回false,以及错误代码
存为lzma文件时必须首先写入文件头,然后再写入压缩数据
### sevenZip.lzma.decodeFile(输入文件路径,输出文件路径,进度回调函数) #
解压文件,
执行成功返回true,否则返回false,以及错误信息,
可选指定进回调函数,回调函数原型如下：
function(inProcessed,outProcessed){ }
回调函数返回true停止解压
### sevenZip.lzma.encodeFile(输入文件路径,输出文件路径,进度回调函数) #
压缩文件,
如果不指定输出路径,则自动添加.lzma后缀作为输出路径
执行成功返回true,否则返回false,以及错误信息,
可选指定进回调函数,回调函数原型如下：
function(inSize,outSize){ }
回调函数返回true停止压缩
### sevenZip.lzma.load(lzma文件路径) #
解压文件并返回字符串
### sevenZip.lzma.save(待压缩数据,输出文件路径,压缩级别,字典大小,线程数,lc,lp,pb,fb) #
压缩字符串并存储到文件
除参数@1,@2以外其他参数可选
### sevenZip.lzma.unCompress(待解压数据,LZMA头) #
解压字符串,
如果待解压数据已包含LZMA头，可省略参数@2
## SEVERZIPLZMAHEADERObject 成员列表
### SEVERZIPLZMAHEADERObject.properties
记录压缩参数,
该值为(pb * 5 + lp) * 9 + lc
### SEVERZIPLZMAHEADERObject.uncompressedSize
文件原始大小