ADC Home > Reference Library > Reference > Hardware & Drivers > Bluetooth > Bluetooth Framework Reference

NSObject(IOBluetoothDeviceInquiryDelegate)

Extends Class:	NSObject
Declared In:	IOBluetoothDeviceInquiry.h

Overview

This category on NSObject describes the delegate methods for the IOBluetoothDeviceInquiry object. All methods are optional, but it is highly recommended you implement them all. Do NOT invoke remote name requests on found IOBluetoothDevice objects unless the inquiry object has been stopped. Doing so may deadlock your process.

Methods

-deviceInquiryComplete
-deviceInquiryComplete:error:aborted:
-deviceInquiryDeviceFound
-deviceInquiryDeviceFound:device:
-deviceInquiryDeviceNameUpdated
-deviceInquiryDeviceNameUpdated:device:devicesRemaining:
-deviceInquiryStarted:
-deviceInquiryUpdatingDeviceNamesStarted
-deviceInquiryUpdatingDeviceNamesStarted:devicesRemaining:

deviceInquiryComplete

See Also:

deviceInquiryComplete:error:aborted:

- (void) deviceInquiryComplete:(IOBluetoothDeviceInquiry*)sender 
        error:(IOReturn)error aborted:(BOOL)aborted;

Parameters

sender: Inquiry object that sent this delegate message.
error: Error code. kIOReturnSuccess if the inquiry completed without incident.
aborted: TRUE if user called -stop on the inquiry.

Discussion

When the inquiry is completely stopped, this delegate method will be invoked. It will supply an error code value, kIOReturnSuccess if the inquiry stopped without problem, otherwise a non-kIOReturnSuccess error code will be supplied.

deviceInquiryComplete:error:aborted:

See Also:

deviceInquiryComplete

- (void) deviceInquiryComplete:(IOBluetoothDeviceInquiry*)sender 
        error:(IOReturn)error aborted:(BOOL)aborted;

Parameters

sender: Inquiry object that sent this delegate message.
error: Error code. kIOReturnSuccess if the inquiry completed without incident.
aborted: TRUE if user called -stop on the inquiry.

Discussion

deviceInquiryDeviceFound

See Also:

deviceInquiryDeviceFound:device:

- (void) deviceInquiryDeviceFound:(IOBluetoothDeviceInquiry*)sender 
        device:(IOBluetoothDevice*)device;

Parameters

sender: Inquiry object that sent this delegate message.
device: IOBluetoothDevice that was found.

Discussion

A new device has been found. You do not need to retain the device - it will be held in the internal storage of the inquiry, and can be accessed later using -foundDevices.

deviceInquiryDeviceFound:device:

See Also:

deviceInquiryDeviceFound

- (void) deviceInquiryDeviceFound:(IOBluetoothDeviceInquiry*)sender 
        device:(IOBluetoothDevice*)device;

Parameters

sender: Inquiry object that sent this delegate message.
device: IOBluetoothDevice that was found.

Discussion

A new device has been found. You do not need to retain the device - it will be held in the internal storage of the inquiry, and can be accessed later using -foundDevices.

deviceInquiryDeviceNameUpdated

See Also:

deviceInquiryDeviceNameUpdated:device:devicesRemaining:

- (void) deviceInquiryDeviceNameUpdated:(IOBluetoothDeviceInquiry*)sender 
        device:(IOBluetoothDevice*)device devicesRemaining:(uint32_t)devicesRemaining;

Parameters

sender: Inquiry object that sent this delegate message.
device: IOBluetoothDevice that was updated.
devicesRemaining: Number of devices remaining to update.

Discussion

A device name has been retrieved. Also indicates how many devices are left to be updated.

deviceInquiryDeviceNameUpdated:device:devicesRemaining:

See Also:

deviceInquiryDeviceNameUpdated

- (void) deviceInquiryDeviceNameUpdated:(IOBluetoothDeviceInquiry*)sender 
        device:(IOBluetoothDevice*)device devicesRemaining:(uint32_t)devicesRemaining;

Parameters

sender: Inquiry object that sent this delegate message.
device: IOBluetoothDevice that was updated.
devicesRemaining: Number of devices remaining to update.

Discussion

A device name has been retrieved. Also indicates how many devices are left to be updated.

deviceInquiryStarted:

- (void) deviceInquiryStarted:(IOBluetoothDeviceInquiry*)sender;

Parameters

sender: Inquiry object that sent this delegate message.

Discussion

This message will be delivered when the inquiry actually starts. Since the inquiry could be throttled, this message may not be received immediately after called -start.

deviceInquiryUpdatingDeviceNamesStarted

See Also:

deviceInquiryUpdatingDeviceNamesStarted:devicesRemaining:

- (void) deviceInquiryUpdatingDeviceNamesStarted:(IOBluetoothDeviceInquiry*)sender 
        devicesRemaining:(uint32_t)devicesRemaining;

Parameters

sender: Inquiry object that sent this delegate message.
devicesRemaining: Number of devices remaining to update.

Discussion

The inquiry has begun updating device names that were found during the search.

deviceInquiryUpdatingDeviceNamesStarted:devicesRemaining:

See Also:

deviceInquiryUpdatingDeviceNamesStarted

- (void) deviceInquiryUpdatingDeviceNamesStarted:(IOBluetoothDeviceInquiry*)sender 
        devicesRemaining:(uint32_t)devicesRemaining;

Parameters

sender: Inquiry object that sent this delegate message.
devicesRemaining: Number of devices remaining to update.

Discussion

The inquiry has begun updating device names that were found during the search.

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