IOBluetoothUIUserLib.h

Overview

This header is a library of functions that allow user-space clients to use the Bluetooth UI C APIs.

For more information on accessing Bluetooth devices, see Working With Bluetooth Devices.

Functions

IOBluetoothDeviceSelectorRunPanelWithAttributes

Runs the selector controller panel displaying devices that have the specified attributes.

IOBluetoothGetDeviceSelectorController

Creates an IOBluetoothDeviceSelectorControllerRef to use with the Bluetooth selector controller functions.

IOBluetoothGetPairingController

Creates an IOBluetoothPairingControllerRef to use with the Bluetooth pairing controller functions.

IOBluetoothPairingControllerRunPanelWithAttributes

Runs the pairing controller with a list of device attributes on which to filter.

IOBluetoothServiceBrowserControllerBrowseDevices

IOBluetoothServiceBrowserControllerCreate

Creates an IOBluetoothServiceBrowserControllerRef to use in the Bluetooth service browser controller functions.

IOBluetoothServiceBrowserControllerDiscover

IOBluetoothServiceBrowserControllerDiscoverWithDeviceAttributes

IOBluetoothServiceBrowserControllerSetOptions

Runs the selector controller panel displaying devices that have the specified attributes.

CFArrayRef IOBluetoothDeviceSelectorRunPanelWithAttributes(
    IOBluetoothDeviceSelectorControllerRef deviceSelector,
    IOBluetoothDeviceSearchAttributes *attributes);  

Parameters

deviceSelector

The IOBluetoothDeviceSelectorControllerRef created in IOBluetoothGetDeviceSelectorController.

attributes

A pointer to a list of device attributes.

Return Value

Returns an array of selected devices.

Creates an IOBluetoothDeviceSelectorControllerRef to use with the Bluetooth selector controller functions.

IOBluetoothDeviceSelectorControllerRef IOBluetoothGetDeviceSelectorController();  

Return Value

Returns the newly created IOBluetoothDeviceSelectorControllerRef.

Creates an IOBluetoothPairingControllerRef to use with the Bluetooth pairing controller functions.

IOBluetoothPairingControllerRef IOBluetoothGetPairingController();  

Return Value

Returns the newly created IOBluetoothPairingControllerRef.

Runs the pairing controller with a list of device attributes on which to filter.

void IOBluetoothPairingControllerRunPanelWithAttributes(
    IOBluetoothPairingControllerRef pairingController,
    IOBluetoothDeviceSearchAttributes *attributes);  

Parameters

pairingController

The IOBluetoothPairingControllerRef created with IOBluetoothGetPairingController.

attributes

A pointer to a list of device attributes.

IOReturn IOBluetoothServiceBrowserControllerBrowseDevices(
    IOBluetoothSDPServiceRecordRef *outRecord,
    IOBluetoothServiceBrowserControllerOptions inOptions);  

Parameters

outRecord

On return, the IOBluetoothSDPServiceRecordRef representing the service the user selects.

inOptions

Creates an IOBluetoothServiceBrowserControllerRef to use in the Bluetooth service browser controller functions.

IOBluetoothServiceBrowserControllerRef IOBluetoothServiceBrowserControllerCreate(
    IOBluetoothServiceBrowserControllerOptions inOptions);  

Parameters

inOptions

One of the options listed in IOBluetoothServiceBrowserControllerOptions.

Return Value

Returns the newly created IOBluetoothServiceBrowserControllerRef.

IOReturn IOBluetoothServiceBrowserControllerDiscover(
    IOBluetoothServiceBrowserControllerRef controller,
    IOBluetoothSDPServiceRecordRef *outRecord);  

Parameters

controller

The IOBluetoothServiceBrowserControllerRef created in IOBluetoothServiceBrowserControllerCreate.

outRecord

On return, the IOBluetoothSDPServiceRecordRef representing the service the user selects.

IOReturn IOBluetoothServiceBrowserControllerDiscoverWithDeviceAttributes(
    IOBluetoothServiceBrowserControllerRef controller,
    IOBluetoothSDPServiceRecordRef *outRecord,
    IOBluetoothDeviceSearchAttributes *deviceAttributes,
    CFArrayRef serviceArray);  

Parameters

controller

The IOBluetoothServiceBrowserControllerRef created in IOBluetoothServiceBrowserControllerCreate.

outRecord

On return, the IOBluetoothSDPServiceRecordRef representing the service the user selects.

deviceAttributes

A pointer to a list of device attributes.

serviceArray

void IOBluetoothServiceBrowserControllerSetOptions(
    IOBluetoothServiceBrowserControllerRef controller,
    IOBluetoothServiceBrowserControllerOptions inOptions);  

Parameters

controller

The IOBluetoothServiceBrowserControllerRef created in IOBluetoothServiceBrowserControllerCreate.

inOptions

Enumerations

enum { 
    kIOBluetoothServiceBrowserControllerOptionsNone = (
        0 << 0L), 
    kIOBluetoothServiceBrowserControllerOptionsAutoStartInquiry = 
    (
        1 << 0L), // this has been deprecated in 10.5, all panels will AutoStart 
    kIOBluetoothServiceBrowserControllerOptionsDisconnectWhenDone = 
    (
        2 << 0L) 
};  

Constants

kIOBluetoothServiceBrowserControllerOptionsNone

No options set.

kIOBluetoothServiceBrowserControllerOptionsAutoStartInquiry

Automatically start an inquiry when the panel is displayed.

kIOBluetoothServiceBrowserControllerOptionsDisconnectWhenDone

Disconnect from the device when UI operations are finished.

Discussion

Option values to customize the behavior of an IOBluetoothServiceBrowserController object.

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-03-11