Platforms to show: All Mac Windows Linux Cross-Platform

Back to WindowsPipeMBS class.

WindowsPipeMBS.BytesAvailable as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Queries number of bytes available in buffer.

(Read only property)

Some examples using this property:

WindowsPipeMBS.BytesRead as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Number of bytes read.

(Read and Write property)

WindowsPipeMBS.BytesWritten as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Number of bytes written.

(Read and Write property)

WindowsPipeMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The handle for the pipe.

(Read only property)

WindowsPipeMBS.InputBufferSize as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The input buffer size.

(Read only property)

Some examples using this property:

WindowsPipeMBS.IsClient as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Whether this is client or server side.

True if this is client side.
(Read only property)

WindowsPipeMBS.IsMessageMode as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Whether this pipe is in message mode.

(Read only property)

WindowsPipeMBS.IsOpen as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Queries whether pipe is open.

(Read only property)

WindowsPipeMBS.IsServer as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Whether this is client or server side.

True if this is server side.
(Read only property)

Some examples using this property:

WindowsPipeMBS.LastError as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The last error code.

A Windows error code.
(Read and Write property)

WindowsPipeMBS.MessageBytesAvailable as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Queries number of bytes available for current message.

(Read only property)

Some examples using this property:

WindowsPipeMBS.Name as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The name of the pipe.

This is name as used in CreatePipe or OpenPipe method.
(Read and Write property)

WindowsPipeMBS.NamedPipeClientComputerName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the client computer name for the specified named pipe.
Example
dim Pipe as WindowsPipeMBS // your pipe

Msgbox "NamedPipeClientComputerName: "+pipe.NamedPipeClientComputerName

(Read only property)

Some examples using this property:

WindowsPipeMBS.NamedPipeClientProcessId as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the client process identifier for the specified named pipe.
Example
dim Pipe as WindowsPipeMBS // your pipe

Msgbox "NamedPipeClientProcessId: "+str(pipe.NamedPipeClientProcessId)

(Read only property)

Some examples using this property:

WindowsPipeMBS.NamedPipeClientSessionId as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the client session identifier for the specified named pipe.
Example
dim Pipe as WindowsPipeMBS // your pipe

Msgbox "NamedPipeClientSessionId: "+str(pipe.NamedPipeClientSessionId)

(Read only property)

Some examples using this property:

WindowsPipeMBS.NamedPipeServerProcessId as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the server process identifier for the specified named pipe.
Example
dim Pipe as WindowsPipeMBS // your pipe

Msgbox "NamedPipeServerProcessId: "+str(pipe.NamedPipeServerProcessId)

(Read only property)

Some examples using this property:

WindowsPipeMBS.NamedPipeServerSessionId as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the server session identifier for the specified named pipe.
Example
dim Pipe as WindowsPipeMBS // your pipe

Msgbox "NamedPipeServerSessionId: "+str(pipe.NamedPipeServerSessionId)

(Read only property)

Some examples using this property:

WindowsPipeMBS.OutputBufferSize as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 19.5 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The output buffer size.

(Read only property)

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


The biggest plugin in space...