CUsbHidFinder クラス

USB-HID検索クラス [詳解]

#include <TnbUsbHidFinder.h>

CUsbHidFinder の継承関係図

公開メンバ関数
void	Close (void)
	[設定] クローズ. [詳解]
	CUsbHidFinder (void)
	コンストラクタ [詳解]
bool	Find (const GUID &g)
	[検索] 検索開始. [詳解]
bool	Find (void)
	[検索] 検索開始 [詳解]
bool	FindMouseHid (void)
	[検索] 検索開始（Mouse指定） [詳解]
const CUsbHidPathName &	Get (void) const
	[取得] 検索結果情報取得 [詳解]
DWORD	GetLastError (void) const
	[取得] エラー情報取得 [詳解]
bool	IsFinding (void) const
	[確認] 検索中確認 [詳解]
bool	Next (void)
	[検索] 次検索 [詳解]

静的公開メンバ関数
static CVectorT< CUsbHidPathName >	EnumPathNames (void)
	[取得] USB-HID パスネーム情報一覧. [詳解]
static CVectorT< CUsbHidPathName >	FindPathNames (int iVendorId, int iProductId)
	[取得] 指定 USB-HID パスネーム情報一覧. [詳解]

限定公開メンバ関数
virtual void	OnClosed (void)
	[通知] クローズ. [詳解]
virtual DWORD	OnFound (LPCTSTR lpszDevicePath)
	[通知] 発見. [詳解]

詳解

USB-HID検索クラス

接続されている USB-HID の検索、および、通信サイズを取得します。
また、指定VID,PID の検索も可能。

必要ファイル

TnbUsbHidFinder.h

日付

07/04/24 新規作成

08/07/07 抽象化したクラスと分離

TnbUsbHidFinder.h の 35 行目に定義があります。

構築子と解体子

CUsbHidFinder()

CUsbHidFinder

(

void

)

コンストラクタ

TnbUsbHidFinder.h の 62 行目に定義があります。

関数詳解

Close()

void Close ( void  )

inherited

[設定] クローズ.

覚え書き

検索中の場合、検索を停止します（ Next() メソッドは false を返すようになります）。

TnbUsbGuidFinder.h の 165 行目に定義があります。

EnumPathNames()

static CVectorT< CUsbHidPathName > EnumPathNames ( void  )

static

[取得] USB-HID パスネーム情報一覧.

接続されている USB-HID パスネーム情報一覧を作成します。

戻り値

発見したパスネーム情報の配列

TnbUsbHidFinder.h の 109 行目に定義があります。

Find() [1/2]

bool Find ( const GUID &  g )

inherited

[検索] 検索開始.

引数

g	検索対象の GUID。

戻り値

true	発見（クラスメソッドに情報あり）
false	未発見／エラー発生（ GetLastError() で情報取得可能）

TnbUsbGuidFinder.h の 191 行目に定義があります。

Find() [2/2]

bool Find

(

void

)

[検索] 検索開始

戻り値

true	発見（クラスメソッドに情報あり）
false	未発見／エラー発生（ GetLastError() で情報取得可能）

TnbUsbHidFinder.h の 71 行目に定義があります。

FindMouseHid()

bool FindMouseHid

(

void

)

[検索] 検索開始（Mouse指定）

戻り値

true	発見（クラスメソッドに情報あり）
false	未発見／エラー発生（ GetLastError() で情報取得可能）

TnbUsbHidFinder.h の 83 行目に定義があります。

FindPathNames()

static CVectorT< CUsbHidPathName > FindPathNames ( int  iVendorId, int  iProductId  )

static

[取得] 指定 USB-HID パスネーム情報一覧.

指定の ID のパスネーム情報を集めます。

引数

iVendorId	ベンダID.
iProductId	プロダクトID.

戻り値

発見したパスネーム情報の配列。

TnbUsbHidFinder.h の 130 行目に定義があります。

Get()

const CUsbHidPathName & Get

(

void

)

const

[取得] 検索結果情報取得

覚え書き

Find() Next() で true の場合、情報が得られます。

戻り値

パスネーム情報の参照。

例外

CEmptyException

未検索、あるいは未発見時に本メソッドをコールすると、スローされます。

TnbUsbHidFinder.h の 95 行目に定義があります。

GetLastError()

DWORD GetLastError ( void  ) const

inherited

[取得] エラー情報取得

覚え書き

Find() Next() で false の場合、本メソッドでエラーか正常終了か判断できます。

戻り値

ERROR_SUCCESS	エラー情報なし。
ERROR_SUCCESS以外	エラー。数値はシステムエラーコードです( SystemErrorToMessageText() で文字列化できます)。

TnbUsbGuidFinder.h の 222 行目に定義があります。

IsFinding()

bool IsFinding ( void  ) const

inherited

[確認] 検索中確認

戻り値

true	検索中。情報を持っている。
false	していない。

TnbUsbGuidFinder.h の 180 行目に定義があります。

Next()

bool Next ( void  )

inherited

[検索] 次検索

覚え書き

Find() で true の場合、次にこのメソッドを使用します。その後繰り返して 本メソッド使うことで複数の情報を得ることが出来ます。

戻り値

true	発見（クラスメソッドに情報あり）
false	未発見／エラー発生（ GetLastError() で情報取得可能）

TnbUsbGuidFinder.h の 204 行目に定義があります。

OnClosed()

virtual void OnClosed ( void  )

protectedvirtual

[通知] クローズ.

覚え書き

検索をクローズした時に通知されます。

CAbstractUsbGuidFinderを実装しています。

TnbUsbHidFinder.h の 54 行目に定義があります。

OnFound()

virtual DWORD OnFound ( LPCTSTR  lpszDevicePath )

protectedvirtual

[通知] 発見.

覚え書き

条件に合うデバイスが見つかった時に通知されます。

引数

lpszDevicePath

デバイスパス名。 CreateFile() 等で使用することが出来ます。

戻り値

エラーコード。

CAbstractUsbGuidFinderを実装しています。

TnbUsbHidFinder.h の 46 行目に定義があります。