IPWorks Bluetooth 2020 C++ Edition

Questions / Feedback?

BTInfo Class

Properties   Methods   Events   Configuration Settings   Errors  

The BTInfo class helps find and manage information about Bluetooth devices and services.

Syntax

BTInfo

Remarks

The BTInfo class may be used to get information about local and nearby Bluetooth devices.

Information about the Bluetooth radios on the local system is obtained through the Radio* properties. Set RadioIndex to select a radio to inspect its values.

The ListDevices method will search for nearby devices and provide results through the Device* properties. The DeviceInfo event will also fire with information about each device.

Call ListServices to list local or remote services. This provides an easy way to discover information about the services on a device, such as which port a service is listening on, before attempting to connect with BTPort. The Service* properties hold information about the services. The ServiceInfo event will also fire for each service.

Additionally the class may be used to manage local services. Call AddLocalService to add a new service. This functionality may be used after BTDaemon is listening to allow clients to connect more easily.

Other methods allow additional functionality, such as ResolveName, ResolveAddress, RequestAuth, and more.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

DeviceAddressThe Bluetooth address of the device identified by DeviceIndex.
DeviceAuthenticatedSpecifies whether the device is authenticated, paired, or bonded.
DeviceClassOfDeviceDevice class for the Bluetooth device.
DeviceConnectedSpecifies whether the device is connected.
DeviceCountThe number of bluetooth devices.
DeviceIndexSets the current device.
DeviceLastSeenLast time the device was seen.
DeviceLastUsedLast time the device was used.
DeviceNameName of the device.
DeviceRememberedWhether the device is a remembered device.
RadioAddressThe Bluetooth address of the radio identified by RadioIndex.
RadioClassOfDeviceDevice class for the local Bluetooth radio.
RadioConnectableGets or sets whether a Bluetooth radio accepts incoming connections.
RadioCountThe number of bluetooth radios in the system.
RadioDiscoverableGets or sets whether a Bluetooth radio is discoverable.
RadioIndexSets the current radio.
RadioManufacturerManufacturer of the Bluetooth radio.
RadioNameName of the Bluetooth radio.
RadioSubversionHolds the radio subversion.
ServiceAddressThe Bluetooth address of the service.
ServiceClassIdThe service class Id (UUID).
ServiceCommentA comment describing the service.
ServiceCountThe number of services on the device.
ServiceIndexSets the current service.
ServiceNameThe name of the service.
ServiceOtherClassIdA list of other class Ids.
ServicePortThe port on which the service is listening.
ServiceProtocolThe protocol used by the service.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AddLocalServiceAdds a local service.
ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
GetServiceInfoRetrieves information about the specified service.
ListDevicesLists all nearby devices.
ListServicesList local or remote services.
RemoveAuthRemoves the authentication of specified device.
RemoveLocalServiceRemoves the selected service.
RequestAuthRequests authentication to a device.
ResolveAddressResolves an Bluetooth address.
ResolveNameResolves a device name to an address.
StartAuthMonitorStart monitoring for authentication requests.
StopAuthMonitorStops monitoring for authentication requests.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

AuthRequestFired when a device requests authentication.
DeviceInfoFired once for each device found when calling ListDevices.
ErrorInformation about errors during data delivery.
ServiceInfoFired once for each service found when calling ListServices.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

InquireFromAllRadiosWhether the inquiry is sent from all radios.
InquiryTimeoutThe approximate time in seconds to wait for an inquiry response.
IssueInquiryWhether an inquiry is performed, or cached values are used.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks Bluetooth 2020 C++ Edition - Version 20.0 [Build 7941]