Platforms to show: All Mac Windows Linux Cross-Platform

WindowsPipeMBS.Close
Type Topic Plugin Version macOS Windows Linux iOS Targets
method Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Function: Closes the pipe.
Notes: Called by destructor automatically.

Feedback, Comments & Corrections

WindowsPipeMBS.Constructor
Type Topic Plugin Version macOS Windows Linux iOS Targets
method Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Function: The constructor.

Feedback, Comments & Corrections

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
Function: Creates a named pipe.
Notes:
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\".

Feedback, Comments & Corrections

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
Function: Opens an existing named pipe from client side.
Notes:
Returns true on success or false on failure.
Lasterror is set.

If name does not start with \ then we prefix it with "\\.\Pipe\".

Feedback, Comments & Corrections

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
Function: Reads data without removing it from the buffer.
Notes:
Reads up to the given number of bytes.
BytesRead property is set and data is returned.
LastError property is set.

Feedback, Comments & Corrections

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
Function: Reads all data without removing it from the buffer.
Notes:
Reads whole message or in byte mode
BytesRead property is set and data is returned.
LastError property is set.

Feedback, Comments & Corrections

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
Function: Reads data.
Notes:
Reads up to the given number of bytes.
BytesRead property is set and data is returned.
LastError property is set.

Feedback, Comments & Corrections

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
Function: Reads all data.
Example:
dim Pipe as WindowsPipeMBS // your pipe

Dim r As String = pipe.ReadAll
Dim d As String = DefineEncoding(r, Encodings.UTF8)

List.AddRow d
Notes:
Reads whole message or in byte mode what is available.
BytesRead property is set and data is returned.
LastError property is set.

Feedback, Comments & Corrections

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
Function: Writes data.
Notes:
Lasterror is set.
BytesWritten is set to number of bytes sent.

See also:

Feedback, Comments & Corrections

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
Function: Writes data.
Example:
dim Pipe as WindowsPipeMBS // your pipe

Dim d As String = ConvertEncoding(MessageField.Text, encodings.UTF8)
If d.Len > 0 Then
pipe.Write d
MessageField.Text = ""
End If
Notes:
Lasterror is set.
BytesWritten is set to number of bytes sent.

See also:

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS Win Plugin.

The biggest plugin in space...




Links
MBS FileMaker tutorial videos

Start Chat