Platforms to show: All Mac Windows Linux Cross-Platform
Back to WindowsPipeMBS class.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 19.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Called by destructor automatically.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 19.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
WindowsPipeMBS.CreatePipe(Name as string, MessageMode as Boolean = false, BufferSize as Integer = &h100000, AllowAllUsers as Boolean = false) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 19.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Buffersize defines the size for input/output buffers.
Returns true on success or false on failure.
Lasterror is set.
Normally the pipe allows only same user.
But if AllowAllUsers is true, you can talk to other users or from service to user.
If name does not start with \ then we prefix it with "\\.\Pipe\".
Some examples using this method:
WindowsPipeMBS.OpenPipe(Name as string) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 19.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Returns true on success or false on failure.
Lasterror is set.
If name does not start with \ then we prefix it with "\\.\Pipe\".
Some examples using this method:
WindowsPipeMBS.Peek(ByteCount as Integer) as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 19.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Reads up to the given number of bytes.
BytesRead property is set and data is returned.
LastError property is set.
WindowsPipeMBS.PeekAll as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 19.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Reads whole message or in byte mode
BytesRead property is set and data is returned.
LastError property is set.
WindowsPipeMBS.Read(ByteCount as Integer) as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 19.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Reads up to the given number of bytes.
BytesRead property is set and data is returned.
LastError property is set.
WindowsPipeMBS.ReadAll as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 19.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Reads whole message or in byte mode what is available.
BytesRead property is set and data is returned.
LastError property is set.
WindowsPipeMBS.Write(data as MemoryBlock)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 19.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Lasterror is set.
BytesWritten is set to number of bytes sent.
See also:
WindowsPipeMBS.Write(data as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 19.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Lasterror is set.
BytesWritten is set to number of bytes sent.
See also:
The items on this page are in the following plugins: MBS Win Plugin.