Interface BluetoothApis

All Superinterfaces:

AltCallingConvention, Library, StdCall, StdCallLibrary

public interface BluetoothApis
extends StdCallLibrary

Provides mappings for the Windows Bluetooth API functions from BluetoothApis.dll.

See Also:

• BluetoothApis.h

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BluetoothApis.BLUETOOTH_ADDRESS	The BLUETOOTH_ADDRESS structure provides the address of a Bluetooth device.
static class	BluetoothApis.BLUETOOTH_DEVICE_INFO	The BLUETOOTH_DEVICE_INFO structure provides information about a Bluetooth device.
static class	BluetoothApis.BLUETOOTH_DEVICE_SEARCH_PARAMS	The BLUETOOTH_DEVICE_SEARCH_PARAMS structure specifies search criteria for Bluetooth device searches.
static class	BluetoothApis.BLUETOOTH_FIND_RADIO_PARAMS	The BLUETOOTH_FIND_RADIO_PARAMS structure facilitates the enumeration of installed Bluetooth radios.
static class	BluetoothApis.BLUETOOTH_RADIO_INFO	The BLUETOOTH_RADIO_INFO structure contains information about a Bluetooth radio.

Nested classes/interfaces inherited from interface Library

Library.Handler

Nested classes/interfaces inherited from interface StdCallLibrary

StdCallLibrary.StdCallCallback

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BLUETOOTH_MAX_NAME_SIZE	Maximum Bluetooth device name length.
static final BluetoothApis	INSTANCE	Instance of BluetoothApis.

Fields inherited from interface Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_SYMBOL_PROVIDER, OPTION_TYPE_MAPPER

Fields inherited from interface StdCallLibrary

FUNCTION_MAPPER, STDCALL_CONVENTION

Method Summary

Modifier and Type	Method	Description
boolean	BluetoothFindDeviceClose(WinNT.HANDLE hFind)	Closes the enumeration handle for Bluetooth devices.
WinNT.HANDLE	BluetoothFindFirstDevice(BluetoothApis.BLUETOOTH_DEVICE_SEARCH_PARAMS pbtsp, BluetoothApis.BLUETOOTH_DEVICE_INFO pbtdi)	Begins the enumeration of Bluetooth devices.
WinNT.HANDLE	BluetoothFindFirstRadio(BluetoothApis.BLUETOOTH_FIND_RADIO_PARAMS pbtfrp, WinNT.HANDLEByReference phRadio)	Finds the first Bluetooth radio installed on the system.
boolean	BluetoothFindNextDevice(WinNT.HANDLE hFind, BluetoothApis.BLUETOOTH_DEVICE_INFO pbtdi)	Finds the next Bluetooth device.
boolean	BluetoothFindNextRadio(WinNT.HANDLE hFind, WinNT.HANDLEByReference phRadio)	Finds the next installed Bluetooth radio.
boolean	BluetoothFindRadioClose(WinNT.HANDLE hFind)	Closes the enumeration handle for Bluetooth radios.
int	BluetoothGetRadioInfo(WinNT.HANDLE hRadio, BluetoothApis.BLUETOOTH_RADIO_INFO pRadioInfo)	Retrieves information about a Bluetooth radio.

Field Details

INSTANCE

static final BluetoothApis INSTANCE

Instance of BluetoothApis.

BLUETOOTH_MAX_NAME_SIZE

static final int BLUETOOTH_MAX_NAME_SIZE

Maximum Bluetooth device name length.

See Also:

• Constant Field Values

Method Details

BluetoothFindFirstRadio

WinNT.HANDLE BluetoothFindFirstRadio(BluetoothApis.BLUETOOTH_FIND_RADIO_PARAMS pbtfrp,
 WinNT.HANDLEByReference phRadio)

Finds the first Bluetooth radio installed on the system.

Parameters:

pbtfrp - A pointer to a BluetoothApis.BLUETOOTH_FIND_RADIO_PARAMS structure.

phRadio - A pointer that receives the handle of the first radio found.

Returns:

A handle to use with BluetoothFindNextRadio(WinNT.HANDLE, WinNT.HANDLEByReference) and BluetoothFindRadioClose(WinNT.HANDLE), or null on failure. Call GetLastError for error information.

See Also:

• BluetoothFindFirstRadio

BluetoothFindNextRadio

boolean BluetoothFindNextRadio(WinNT.HANDLE hFind,
 WinNT.HANDLEByReference phRadio)

Finds the next installed Bluetooth radio.

Parameters:

hFind - The handle returned by BluetoothFindFirstRadio(BluetoothApis.BLUETOOTH_FIND_RADIO_PARAMS, WinNT.HANDLEByReference).

phRadio - A pointer that receives the handle of the next radio found.

Returns:

true if another radio was found, false otherwise.

See Also:

• BluetoothFindNextRadio

BluetoothFindRadioClose

boolean BluetoothFindRadioClose(WinNT.HANDLE hFind)

Closes the enumeration handle for Bluetooth radios.

Parameters:

hFind - The handle returned by BluetoothFindFirstRadio(BluetoothApis.BLUETOOTH_FIND_RADIO_PARAMS, WinNT.HANDLEByReference).

Returns:

true on success, false on failure.

See Also:

• BluetoothFindRadioClose

BluetoothGetRadioInfo

int BluetoothGetRadioInfo(WinNT.HANDLE hRadio,
 BluetoothApis.BLUETOOTH_RADIO_INFO pRadioInfo)

Retrieves information about a Bluetooth radio.

Parameters:

hRadio - A handle to the Bluetooth radio obtained from BluetoothFindFirstRadio(BluetoothApis.BLUETOOTH_FIND_RADIO_PARAMS, WinNT.HANDLEByReference).

pRadioInfo - A pointer to a BluetoothApis.BLUETOOTH_RADIO_INFO structure to receive the radio information.

Returns:

ERROR_SUCCESS (0) on success, or an error code on failure.

See Also:

• BluetoothGetRadioInfo

BluetoothFindFirstDevice

WinNT.HANDLE BluetoothFindFirstDevice(BluetoothApis.BLUETOOTH_DEVICE_SEARCH_PARAMS pbtsp,
 BluetoothApis.BLUETOOTH_DEVICE_INFO pbtdi)

Begins the enumeration of Bluetooth devices.

Parameters:

pbtsp - A pointer to a BluetoothApis.BLUETOOTH_DEVICE_SEARCH_PARAMS structure specifying search criteria.

pbtdi - A pointer to a BluetoothApis.BLUETOOTH_DEVICE_INFO structure to receive the first device found.

Returns:

A handle to use with BluetoothFindNextDevice(WinNT.HANDLE, BluetoothApis.BLUETOOTH_DEVICE_INFO) and BluetoothFindDeviceClose(WinNT.HANDLE), or null if no devices are found.

See Also:

• BluetoothFindFirstDevice

BluetoothFindNextDevice

boolean BluetoothFindNextDevice(WinNT.HANDLE hFind,
 BluetoothApis.BLUETOOTH_DEVICE_INFO pbtdi)

Finds the next Bluetooth device.

Parameters:

hFind - The handle returned by BluetoothFindFirstDevice(BluetoothApis.BLUETOOTH_DEVICE_SEARCH_PARAMS, BluetoothApis.BLUETOOTH_DEVICE_INFO).

pbtdi - A pointer to a BluetoothApis.BLUETOOTH_DEVICE_INFO structure to receive the next device found.

Returns:

true if another device was found, false otherwise.

See Also:

• BluetoothFindNextDevice

BluetoothFindDeviceClose

boolean BluetoothFindDeviceClose(WinNT.HANDLE hFind)

Closes the enumeration handle for Bluetooth devices.

Parameters:

hFind - The handle returned by BluetoothFindFirstDevice(BluetoothApis.BLUETOOTH_DEVICE_SEARCH_PARAMS, BluetoothApis.BLUETOOTH_DEVICE_INFO).

Returns:

true on success, false on failure.

See Also:

• BluetoothFindDeviceClose