Platforms to show: All Mac Windows Linux Cross-Platform

Back to IOBluetoothDeviceInquiryMBS class.

IOBluetoothDeviceInquiryMBS.clearFoundDevices

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Removes all found devices from the inquiry object.

IOBluetoothDeviceInquiryMBS.Constructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Creates an inquiry object.

The inquiry is not automatically started. You musts call start on it to start the search for in-range devices.

IOBluetoothDeviceInquiryMBS.Destructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
The destructor.

IOBluetoothDeviceInquiryMBS.foundDevices as IOBluetoothDeviceMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Returns found IOBluetoothDevice objects as an array.

Will not return nil. If there are no devices found, returns an array with length of 0.

IOBluetoothDeviceInquiryMBS.setSearchCriteria(ServiceClassMajor as Integer, MajorDeviceClass as Integer, MinorDeviceClass as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Use this method to set the criteria for the device search.

inServiceClassMajor: Set the major service class for found devices. Set to kBluetoothServiceClassMajorAny for all devices. See BluetoothAssignedNumbers.h for possible values.
inMajorDeviceClass: Set the major device class for found devices. Set to kBluetoothDeviceClassMajorAny for all devices. See BluetoothAssignedNumbers.h for possible values.
inMinorDeviceClass: Set the minor device class for found devices. Set to kBluetoothDeviceClassMinorAny for all devices. See BluetoothAssignedNumbers.h for possible values.

The default inquiry object will search for all types of devices. If you wish to find only keyboards, for example, you might use this method like this:

setSearchCriteria(kBluetoothServiceClassMajorAny, kBluetoothDeviceClassMajorPeripheral, kBluetoothDeviceClassMinorPeripheral1Keyboard)

However, we recommend only using this if you are certain of the device class you are looking for, as some devices may report a different/unexpected device class, and the search may miss the device you are interested in.

IOBluetoothDeviceInquiryMBS.Start

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Tells inquiry object to begin the inquiry and name updating process, if specified.

Sets lasterror to kIOReturnSuccess if start was successful. Returns kIOReturnBusy if the object is already in process. May return other IOReturn values, as appropriate.

Calling start multiple times in rapid succession or back-to-back will probably not produce the intended results. Inquiries are throttled if they are called too quickly in succession.

IOBluetoothDeviceInquiryMBS.Stop

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Bluetooth MBS Bluetooth Plugin 18.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Halts the inquiry object.

Could either stop the search for new devices, or the updating of found device names.

Lasterorr is set to kIOReturnSuccess if the inquiry is successfully stopped. Or set to kIOReturnNotPermitted if the inquiry object is already stopped. May set other IOReturn values, as appropriate.

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


The biggest plugin in space...