Bluetooth(CE) ローカル管理. [詳解]

#include <TnbCeBluetooth.h>

CBluetoothLocal の継承関係図

公開型
enum	EMode { PowerOff = -1 , DisabledAll = 0 , EnabledInquiry = 1 , EnabledPageScan = 2 , EnabledAll = 3 }
	モード [詳解]

公開メンバ関数
	CBluetoothLocal (void)
	コンストラクタ [詳解]

bool	ClearInquiryFilter (void)
	[設定] Inquiryフィルタ設定解除. [詳解]

bool	EnableAuthentication (bool isEnable)
	[設定] 認証有効無効. [詳解]

bool	GetAddress (CBluetoothAddress &_addr) const
	[取得] アドレス取得. [詳解]

bool	GetClass (CBluetoothClass &_class) const
	[取得] デバイスクラス取得. [詳解]

bool	GetMode (EMode &_mode) const
	[取得] モード取得. [詳解]

CStr	GetName (void) const
	[取得] 名前取得. [詳解]

bool	GetPageTimeout (DWORD &_timeout) const
	[取得] ページタイムアウト時間取得. [詳解]

bool	GetPageTimeoutMs (DWORD &_timeout) const
	[取得] ページタイムアウト時間取得. [詳解]

int	GetStatus (void) const
	[取得] 状態取得. [詳解]

CVectorT< BthInquiryResult >	Inquiry (DWORD timeout=1000) const
	[検索] Inquiry実行. [詳解]

bool	IsEnabledAuthentication (bool &_isEnabled) const
	[取得] 認証状態取得. [詳解]

bool	SetClass (const CBluetoothClass &clas)
	[設定] デバイスクラス設定. [詳解]

bool	SetInquiryFilter (const CBluetoothAddress &addr)
	[設定] Inquiryフィルタ設定. [詳解]

bool	SetMode (EMode mode, DWORD timeout=3000)
	[設定] モード設定. [詳解]

bool	SetName (LPCTSTR lpszName)
	[設定] 名前設定. [詳解]

bool	SetPageTimeout (DWORD timeout)
	[設定] ページタイムアウト時間設定. [詳解]

bool	SetPageTimeoutMs (DWORD timeout)
	[設定] ページタイムアウト時間設定. [詳解]

bool	TerminateIdleConnections (void)
	[設定] アイドル接続切断. [詳解]

詳解

Bluetooth(CE) ローカル管理.

自分自身のデバイスを管理.

必要ファイル: TnbCeBluetooth.h

日付: 09/10/01 新規作成

TnbCeBluetooth.h の 1166 行目に定義があります。

列挙型メンバ詳解

◆ EMode

enum EMode

モード

列挙値
PowerOff	Power OFF。
DisabledAll	Power ON。Inquiry は Disable、 Page Scan は Disable。
EnabledInquiry	Power ON。Inquiry は Enable、 Page Scan は Disable。
EnabledPageScan	Power ON。Inquiry は Disable、 Page Scan は Enable。
EnabledAll	Power ON。Inquiry は Enable、 Page Scan は Enable。

TnbCeBluetooth.h の 1271 行目に定義があります。

構築子と解体子

◆ CBluetoothLocal()

CBluetoothLocal ( void )

コンストラクタ

TnbCeBluetooth.h の 1172 行目に定義があります。

関数詳解

◆ ClearInquiryFilter()

bool ClearInquiryFilter ( void )

[設定] Inquiryフィルタ設定解除.

SetInquiryFilter() での指定を解除します。

覚え書き: 一つだけの解除は出来ません。

戻り値

true	取得成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1478 行目に定義があります。

◆ EnableAuthentication()

bool EnableAuthentication ( bool isEnable )

[設定] 認証有効無効.

引数

isEnable ture なら認証を有効、 false なら無効にします。

戻り値

true	成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1248 行目に定義があります。

◆ GetAddress()

bool GetAddress ( CBluetoothAddress & _addr ) const

[取得] アドレス取得.

引数

[out] _addr 取得したアドレスが格納されます。

戻り値

true	成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1182 行目に定義があります。

◆ GetClass()

bool GetClass ( CBluetoothClass & _class ) const

[取得] デバイスクラス取得.

引数

[out] _class 取得したデバイスクラス

戻り値

true	成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1222 行目に定義があります。

◆ GetMode()

bool GetMode ( EMode & _mode ) const

[取得] モード取得.

引数

[out] _mode モードが格納されます。

戻り値

true	取得成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1286 行目に定義があります。

◆ GetName()

CStr GetName ( void ) const

[取得] 名前取得.

戻り値

Empty状態	エラー。詳細は、 ::GetLastError() で得られます。
それ以外	成功。内容は名前。

TnbCeBluetooth.h の 1198 行目に定義があります。

◆ GetPageTimeout()

bool GetPageTimeout ( DWORD & _timeout ) const

[取得] ページタイムアウト時間取得.

引数

[out] _timeout 時間が格納される。数値 x 0.625ms が実時間

戻り値

true	成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1368 行目に定義があります。

◆ GetPageTimeoutMs()

bool GetPageTimeoutMs ( DWORD & _timeout ) const

[取得] ページタイムアウト時間取得.

覚え書き: 時間をミリ秒で扱いますが、誤差がでます。

引数

[out] _timeout 時間が格納される。単位はミリ秒。

戻り値

true	成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1398 行目に定義があります。

◆ GetStatus()

int GetStatus ( void ) const

[取得] 状態取得.

装置の状態を取得します。

戻り値

HCI_HARDWARE_RUNNING	The adapter is installed and the stack is running.
HCI_HARDWARE_INITIALIZING	The adapter might be installed. The stack is currently on the way up. Call again later.
HCI_HARDWARE_ERROR	The adapter might be installed. The stack is on the way down. Call again later.
HCI_HARDWARE_SHUTDOWN	The adapter is installed, but the stack is not running.
HCI_HARDWARE_NOT_PRESENT	The adapter is not present.
HCI_HARDWARE_UNKNOWN	The stack is not present. 詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1435 行目に定義があります。

◆ Inquiry()

CVectorT< BthInquiryResult > Inquiry ( DWORD timeout = 1000 ) const

[検索] Inquiry実行.

周りのデバイスを検索します。

引数

timeout 検索時間(単位；ms)。精度は 1280ms です。最大は 60秒です。

戻り値: アドレス一覧. Invalid 状態ならエラー。

TnbCeBluetooth.h の 1489 行目に定義があります。

◆ IsEnabledAuthentication()

bool IsEnabledAuthentication ( bool & _isEnabled ) const

[取得] 認証状態取得.

引数

[out] _isEnabled 認証状態が格納されます。 ture なら認証を有効、 false なら無効を表します。

戻り値

true	取得成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1259 行目に定義があります。

◆ SetClass()

bool SetClass ( const CBluetoothClass & clas )

[設定] デバイスクラス設定.

引数

clas デバイスクラス

戻り値

true	成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1236 行目に定義があります。

◆ SetInquiryFilter()

bool SetInquiryFilter ( const CBluetoothAddress & addr )

[設定] Inquiryフィルタ設定.

指定のアドレスを検索対象にします。

覚え書き: 複数個対象にしたい場合、本メソッドを数回使います。

引数

addr アドレス。

戻り値

true	取得成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1465 行目に定義があります。

◆ SetMode()

bool SetMode	(	EMode	mode,
		DWORD	timeout = `3000`
	)

[設定] モード設定.

覚え書き: OFFからONにする場合、時間がかかることがあります。その最大待ち時間を指定できます。

引数

mode	モード。
timeout	OFF->ONのタイムアウト時間(ms)。時間内に OFF->ONにならなかった時、 GetLastError() は ERROR_TIMEOUT を返します。

戻り値

true	設定成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1318 行目に定義があります。

◆ SetName()

bool SetName ( LPCTSTR lpszName )

[設定] 名前設定.

引数

lpszName 設定する名前

戻り値

true	成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1210 行目に定義があります。

◆ SetPageTimeout()

bool SetPageTimeout ( DWORD timeout )

[設定] ページタイムアウト時間設定.

引数

timeout 時間。数値 x 0.625ms が実時間。

戻り値

true	成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1385 行目に定義があります。

◆ SetPageTimeoutMs()

bool SetPageTimeoutMs ( DWORD timeout )

[設定] ページタイムアウト時間設定.

覚え書き: 時間をミリ秒で扱いますが、誤差がでます。

引数

timeout 時間。単位はミリ秒。

戻り値

true	成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1417 行目に定義があります。

◆ TerminateIdleConnections()

bool TerminateIdleConnections ( void )

[設定] アイドル接続切断.

戻り値

true	成功。
false	失敗。詳細は、 ::GetLastError() で得られます。

TnbCeBluetooth.h の 1452 行目に定義があります。

公開型

公開メンバ関数

詳解

列挙型メンバ詳解

◆ EMode

構築子と解体子

◆ CBluetoothLocal()

関数詳解

◆ ClearInquiryFilter()

◆ EnableAuthentication()

◆ GetAddress()

◆ GetClass()

◆ GetMode()

◆ GetName()

◆ GetPageTimeout()

◆ GetPageTimeoutMs()

◆ GetStatus()

◆ Inquiry()

◆ IsEnabledAuthentication()

◆ SetClass()

◆ SetInquiryFilter()

◆ SetMode()

◆ SetName()

◆ SetPageTimeout()

◆ SetPageTimeoutMs()

◆ TerminateIdleConnections()