Platforms to show: All Mac Windows Linux Cross-Platform

Back to WindowsBlueToothSocketMBS class.

WindowsBlueToothSocketMBS.Authenticate as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
Whether to autheticate connection.

For disconnected sockets, the Authenticate options specifies whether authentication is required for a connect or accept operation to complete successfully. Setting this socket option actively initiates authentication during connection establishment, if the two Bluetooth devices were not previously authenticated. The user interface for passkey exchange, if necessary, is provided by the operating system outside the application context.

For outgoing connections that require authentication, the connect operation fails with WSAEACCES if authentication is not successful. In response, the application may prompt the user to authenticate the two Bluetooth devices before connection.
For incoming connections, the connection is rejected if authentication cannot be established and returns a WSAEHOSTDOWN error. For more information about authenticating Bluetooth devices, see BluetoothAuthenticateDevice function.

Lasterror is set.
(Read and Write property)

WindowsBlueToothSocketMBS.AvailableBytes as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
Queries available bytes in input buffer.

Lasterror is set.
Returns -1 if unknown.
(Read only property)

WindowsBlueToothSocketMBS.BindAddress as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
The address the socket is bound to.

(Read only property)

WindowsBlueToothSocketMBS.BindPort as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
The port the socket is bound to.

(Read only property)

WindowsBlueToothSocketMBS.Encrypt as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
Whether to encrypt connection.

On unconnected sockets, the Encrypt socket option enforces encryption to establish a connection. Encryption is only available for authenticated connections. For incoming connections, a connection for which encryption cannot be established is automatically rejected and returns WSAEHOSTDOWN as the error. For outgoing connections, the connect function fails with WSAEACCES if encryption cannot be established. In response, the application may prompt the user to authenticate the two Bluetooth devices before connection. For more information about authenticating Bluetooth devices, see BluetoothAuthenticateDevice.

Windows XP with SP2: For a socket that is connected and authenticated, SO_BTH_ENCRYPT starts encryption.
(Read and Write property)

WindowsBlueToothSocketMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
The internal socket reference number.

(Read only property)

WindowsBlueToothSocketMBS.Lasterror as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
The last error code.

(Read only property)

WindowsBlueToothSocketMBS.LastErrorMessage as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.3 ❌ No ✅ Yes ❌ No ❌ No All
The last error message.

(Read only property)

WindowsBlueToothSocketMBS.Listening as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
Whether we are listening.

Set to true on success by Bind method.
(Read only property)

WindowsBlueToothSocketMBS.LocalAddress as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
Queries local bluetooth address.

Lasterror is set.
Value is empty if not known.
(Read only property)

WindowsBlueToothSocketMBS.LocalPort as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
Queries local port.

Value is -1 if not set.
Lasterror is set.
(Read only property)

WindowsBlueToothSocketMBS.MTU as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
The MTU property.

The MTU socket option is an advanced option used primarily for validation. The MTU option obtains or sets default RFCOMM MTU (maximum transmission unit) for connection negotiation to a value different than the RFCOMM protocol-default value.
Because MTU is affected by the underlying L2CAP MTU, and protocol and application minimums and maximums, the default value for SO_BTH_MTU is only a starting point for negotiation with the remote peer, and the final negotiated MTU is likely to vary from the default. Setting the MTU value may negatively affect throughput, and as such, any modification should be performed with knowledge of the underlying Bluetooth protocol.

The MTU socket option can be performed on connected sockets, but has no effect if the negotiation has already completed. Setting it on the listening (server) socket has no effect.

The amount of data that an application can send or receive in a single socket call is not affected by the MTU; MTU only affects how the underlying Windows Sockets service provider segments packets for transport. Both the proposed MTU and the MTU ultimately negotiated must be between RFCOMM_MIN_MTU (&h17) and RFCOMM_MAX_MTU (&3F3), as defined in the Ws2bth.h header file.
(Read and Write property)

WindowsBlueToothSocketMBS.MTUMax as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
The MTU max property.

The MTUMax socket option is an advanced option used primarily for validation. The MTUMax socket option sets the maximum RFCOMM MTU (maximum transmission unit) for connection negotiation. Connections with an RFCOMM MTU equal to or greater than this value fail during the connect/accept process. While setting this socket option is allowed for a connected socket, it has no effect if the negotiation has completed. Setting this socket option on a listening socket propagates the value for all incoming connections. The MAX MTU value must be between RFCOMM_MIN_MTU (&h17) and RFCOMM_MAX_MTU (&3F3), as defined in the Ws2bth.h header file.
(Read and Write property)

WindowsBlueToothSocketMBS.MTUMin as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
The MTU min property.

The MTUMin socket option is an advanced option used primarily for validation. The MTUMin socket option sets the minimum RFCOMM MTU (maximum transmission unit) for connection negotiation. Connections with an RFCOMM MTU smaller than this value fail during the connect/accept process. While setting this socket option is allowed for a connected socket, it has no effect if the negotiation has completed. Setting this socket option on a listening socket propagates the value for all incoming connections.
Only a listening socket can revise the MTU downward, therefore if the value proposed by the connecting socket is less than the value set for MTUMin on the listening socket, the connection is refused. The minimum MTU must be between RFCOMM_MIN_MTU (&h17) and RFCOMM_MAX_MTU (&3F3), as defined in the Ws2bth.h header file.
(Read and Write property)

WindowsBlueToothSocketMBS.RemoteAddress as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
Queries remote address.

Lasterror is set.
Value is empty if not known.
(Read only property)

WindowsBlueToothSocketMBS.RemotePort as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
Queries remote port.

Lasterror is set.
Value is -1 if not set.
(Read only property)

WindowsBlueToothSocketMBS.SDPRecordID as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Bluetooth MBS Bluetooth Plugin 18.1 ❌ No ✅ Yes ❌ No ❌ No All
The SPF record ID for published service.

(Read only property)

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


The biggest plugin in space...