# fsys.namedPipe 库模块帮助文档

## fsys 成员列表 <a id="fsys" href="#fsys">&#x23;</a>

### fsys.namedPipe("\\.\pipe\pipename",2,2000) <a id="fsys.namedPipe" href="#fsys.namedPipe">&#x23;</a>
参数分别为管道名,最大实例数,超时值  
其他参数就参考源码

### fsys.namedPipe() <a id="fsys.namedPipe" href="#fsys.namedPipe">&#x23;</a>
[返回对象:fsysPipeObject](#fsysPipeObject)

## fsys.namedPipe 成员列表 <a id="fsys.namedPipe" href="#fsys.namedPipe">&#x23;</a>

### fsys.namedPipe.wait("\\.\pipe\pipename","r+") <a id="fsys.namedPipe.wait" href="#fsys.namedPipe.wait">&#x23;</a>
等待并打开可用管道

### fsys.namedPipe.wait() <a id="fsys.namedPipe.wait" href="#fsys.namedPipe.wait">&#x23;</a>
[返回对象:fsysPipeObject](#fsysPipeObject)

## fsysPipeObject 成员列表 <a id="fsysPipeObject" href="#fsysPipeObject">&#x23;</a>

### fsysPipeObject.close() <a id="fsysPipeObject.close" href="#fsysPipeObject.close">&#x23;</a>
关闭文件句柄

### fsysPipeObject.connect() <a id="fsysPipeObject.connect" href="#fsysPipeObject.connect">&#x23;</a>
等待客户端连接

### fsysPipeObject.disconnect() <a id="fsysPipeObject.disconnect" href="#fsysPipeObject.disconnect">&#x23;</a>
断开客户端连接

### fsysPipeObject.flush() <a id="fsysPipeObject.flush" href="#fsysPipeObject.flush">&#x23;</a>
刷新缓冲区

### fsysPipeObject.getClientComputerName() <a id="fsysPipeObject.getClientComputerName" href="#fsysPipeObject.getClientComputerName">&#x23;</a>
返回客户端计算机名，不支持WinXP系统

### fsysPipeObject.getClientProcessId() <a id="fsysPipeObject.getClientProcessId" href="#fsysPipeObject.getClientProcessId">&#x23;</a>
返回客户端进程ID

### fsysPipeObject.getClientSessionId() <a id="fsysPipeObject.getClientSessionId" href="#fsysPipeObject.getClientSessionId">&#x23;</a>
返回客户端会话ID

### fsysPipeObject.handle <a id="fsysPipeObject.handle" href="#fsysPipeObject.handle">&#x23;</a>
返回文件句柄

### fsysPipeObject.path <a id="fsysPipeObject.path" href="#fsysPipeObject.path">&#x23;</a>
返回文件路径

### fsysPipeObject.peek() <a id="fsysPipeObject.peek" href="#fsysPipeObject.peek">&#x23;</a>
如果命名管道中有数据则返回数据

### fsysPipeObject.read() <a id="fsysPipeObject.read" href="#fsysPipeObject.read">&#x23;</a>
读取一行文本  
返回文本不包含回车换行符

### fsysPipeObject.read(-1) <a id="fsysPipeObject.read" href="#fsysPipeObject.read">&#x23;</a>
读取所有内容到文件尾部

### fsysPipeObject.read({int number} ) <a id="fsysPipeObject.read" href="#fsysPipeObject.read">&#x23;</a>
参数可以是一个结构体  
不支持多参数

### fsysPipeObject.read(字节数) <a id="fsysPipeObject.read" href="#fsysPipeObject.read">&#x23;</a>
读取指定长度的字节  
不支持多参数

### fsysPipeObject.readBuffer <a id="fsysPipeObject.readBuffer" href="#fsysPipeObject.readBuffer">&#x23;</a>
读取数据到 buffer ,成功返回读取长度,失败返回null

### fsysPipeObject.readBuffer(buffer,读取长度) <a id="fsysPipeObject.readBuffer" href="#fsysPipeObject.readBuffer">&#x23;</a>
直接读数据到内存  
参数@1可以是 buffer 对象,或内存指针,  
如果是指针则必须指定读取长度,否则长度参数可选  
成功返回读取长度

### fsysPipeObject.seek("cur",) <a id="fsysPipeObject.seek" href="#fsysPipeObject.seek">&#x23;</a>
移动至相对当前位置的指定偏移量

### fsysPipeObject.seek("end") <a id="fsysPipeObject.seek" href="#fsysPipeObject.seek">&#x23;</a>
移动指针至结束处  
返回当前位置,返回值大于2GB则为负值,  
获取文件大小推荐使用 size() 函数

### fsysPipeObject.seek("end",) <a id="fsysPipeObject.seek" href="#fsysPipeObject.seek">&#x23;</a>
移动至相对结束处的指定偏移量

### fsysPipeObject.seek("set") <a id="fsysPipeObject.seek" href="#fsysPipeObject.seek">&#x23;</a>
移动指针到开始

### fsysPipeObject.seek("set",) <a id="fsysPipeObject.seek" href="#fsysPipeObject.seek">&#x23;</a>
移动至相对开始处的指定偏移量

### fsysPipeObject.seek() <a id="fsysPipeObject.seek" href="#fsysPipeObject.seek">&#x23;</a>
得到当前位置

### fsysPipeObject.seteof() <a id="fsysPipeObject.seteof" href="#fsysPipeObject.seteof">&#x23;</a>
设置文件结束

### fsysPipeObject.size() <a id="fsysPipeObject.size" href="#fsysPipeObject.size">&#x23;</a>
返回文件大小  
可选参数一指定单位大小(默认自动选择),  
可选用参数二指定小数精度(默认为2)  
返回文件大小,单位大小,单位名("bytes","KB","MB","GB"等)

### fsysPipeObject.size64() <a id="fsysPipeObject.size64" href="#fsysPipeObject.size64">&#x23;</a>
返回文件大小  
返回值为math.size64长整数对象  

[返回对象:mathSize64Object](https://www.aardio.com/zh-cn/docs/library-reference/math/_.html#mathSize64Object)

### fsysPipeObject.write(字符串) <a id="fsysPipeObject.write" href="#fsysPipeObject.write">&#x23;</a>
写入字符串  
参数也可以是数值、结构体

### fsysPipeObject.writeBuffer <a id="fsysPipeObject.writeBuffer" href="#fsysPipeObject.writeBuffer">&#x23;</a>
写入缓冲区数据,成功返回写入长度,失败返回null

### fsysPipeObject.writeBuffer(buffer,写入长度) <a id="fsysPipeObject.writeBuffer" href="#fsysPipeObject.writeBuffer">&#x23;</a>
直接写数据到内存  
参数@1可以是 buffer 对象,或内存指针,  
如果是指针则必须指定写入长度,否则长度参数可选  
成功返回写入长度
