CUsbHidPathName クラス

USB-HIDパスネーム情報管理クラス [詳解]

#include <TnbUsbHidPathName.h>

CUsbHidPathName の継承関係図

クラス
struct	TDescriptionStrings
	Description 文字列群 [詳解]

公開メンバ関数
	CUsbHidPathName (void)
	コンストラクタ [詳解]
	CUsbHidPathName (WORD wVid, WORD wPid, LPCTSTR lpszPathName, const HIDP_CAPS &cap)
	コンストラクタ [詳解]
void	Empty (void)
	[設定] 情報なし [詳解]
bool	GetButtonCaps (CWorkMemT< HIDP_BUTTON_CAPS > &_vn, HIDP_REPORT_TYPE reportType)
	[設定] ボタン性能情報取得. [詳解]
const HIDP_CAPS &	GetCapability (void) const
	[取得] Capability情報取得 [詳解]
CStr	GetDeviceDescription (void) const
	[取得] 説明取得. [詳解]
size_t	GetFeatureReportByteLength (void) const
	[取得] Featureレポート長取得 [詳解]
size_t	GetInputReportByteLength (void) const
	[取得] Inputレポート長取得 [詳解]
bool	GetLinkCollectionNodes (CWorkMemT< HIDP_LINK_COLLECTION_NODE > &_vn)
	[設定] リンクコレクションノード情報取得. [詳解]
CStr	GetLocationInformation (void) const
	[取得] 場所情報取得. [詳解]
CStr	GetManufacturer (void) const
	[取得] 製造業者取得. [詳解]
bool	GetManufacturerString (TDescriptionStrings &_ds) const
	[取得] Description 文字列取得. [詳解]
size_t	GetOutputReportByteLength (void) const
	[取得] Outputレポート長取得 [詳解]
const CStr &	GetPathName (void) const
	[取得] パスネーム取得 [詳解]
WORD	GetProductId (void) const
	[取得] プロダクトID取得 [詳解]
bool	GetValueCaps (CWorkMemT< HIDP_VALUE_CAPS > &_vn, HIDP_REPORT_TYPE reportType)
	[設定] 値性能情報取得. [詳解]
WORD	GetVendorId (void) const
	[取得] ベンダID取得 [詳解]
bool	IsEmpty (void) const
	[確認] 情報有無確認 [詳解]
DWORD	SetPathName (LPCTSTR lpszPathName)
	[設定] パスネーム設定. [詳解]
CStr	ToString (void) const
	[取得] 文字列取得. [詳解]

詳解

USB-HIDパスネーム情報管理クラス

USB-HID のデバイスを一意に示すパスネーム(文字列)と、それに対応する
Vendor-ID,Product-IDとパスネームとCapabiliryを管理。

存在しない USB-HIDのデバイスのパスネームは管理できません。

参照

CUsbHid

覚え書き

複製可能

「パスネーム」とは、実際にその HIDデバイスをオープンするために使用します。

必要ファイル

TnbUsbHidPathName.h

日付

07/04/26 新規作成

10/02/04 DDK がなくても使えるように宣言を内包した。

10/02/23 GetManufacturer() , GetDeviceDescription() など、取得メソッド追加。

11/01/19 ToString() を追加。

TnbUsbHidPathName.h の 584 行目に定義があります。

構築子と解体子

CUsbHidPathName() [1/2]

CUsbHidPathName

(

void

)

コンストラクタ

覚え書き

Empty 状態のクラスを作成します。

TnbUsbHidPathName.h の 592 行目に定義があります。

CUsbHidPathName() [2/2]

CUsbHidPathName	(	WORD	wVid,
		WORD	wPid,
		LPCTSTR	lpszPathName,
		const HIDP_CAPS &	cap
	)

コンストラクタ

覚え書き

指定の情報を持ったクラスを作成します。

引数

wVid	Vendor ID。
wPid	Product ID。
lpszPathName	パスネーム。
cap	Capability情報

TnbUsbHidPathName.h の 605 行目に定義があります。

関数詳解

Empty()

void Empty

(

void

)

[設定] 情報なし

覚え書き

本インスタンスの情報をクリアし、情報無し状態にします。

TnbUsbHidPathName.h の 625 行目に定義があります。

GetButtonCaps()

bool GetButtonCaps	(	CWorkMemT< HIDP_BUTTON_CAPS > &	_vn,
		HIDP_REPORT_TYPE	reportType
	)

[設定] ボタン性能情報取得.

引数

[out]	_vn	成功時情報が格納されます。
[in]	reportType	レポートタイプ

戻り値

true	成功。
false	失敗

TnbUsbHidPathName.h の 719 行目に定義があります。

GetCapability()

const HIDP_CAPS & GetCapability

(

void

)

const

[取得] Capability情報取得

戻り値

情報の参照。

TnbUsbHidPathName.h の 798 行目に定義があります。

GetDeviceDescription()

CStr GetDeviceDescription

(

void

)

const

[取得] 説明取得.

覚え書き

レジストリから取得しています。

戻り値

説明

TnbUsbHidPathName.h の 878 行目に定義があります。

GetFeatureReportByteLength()

size_t GetFeatureReportByteLength

(

void

)

const

[取得] Featureレポート長取得

戻り値

Featureレポート長。

TnbUsbHidPathName.h の 852 行目に定義があります。

GetInputReportByteLength()

size_t GetInputReportByteLength

(

void

)

const

[取得] Inputレポート長取得

戻り値

Inputレポート長。

TnbUsbHidPathName.h の 834 行目に定義があります。

GetLinkCollectionNodes()

bool GetLinkCollectionNodes

(

CWorkMemT< HIDP_LINK_COLLECTION_NODE > &

_vn

)

[設定] リンクコレクションノード情報取得.

引数

[out]

_vn

成功時情報が格納されます。

戻り値

true	成功。
false	失敗

TnbUsbHidPathName.h の 690 行目に定義があります。

GetLocationInformation()

CStr GetLocationInformation

(

void

)

const

[取得] 場所情報取得.

覚え書き

レジストリから取得しています。

戻り値

場所情報

TnbUsbHidPathName.h の 894 行目に定義があります。

GetManufacturer()

CStr GetManufacturer

(

void

)

const

[取得] 製造業者取得.

覚え書き

レジストリから取得しています。

戻り値

製造業者

TnbUsbHidPathName.h の 862 行目に定義があります。

GetManufacturerString()

bool GetManufacturerString

(

TDescriptionStrings &

_ds

)

const

[取得] Description 文字列取得.

覚え書き

一度デバイスをオープンして取得しています。

引数

[out]

_ds

成功するとDescription 文字列が格納されます。

戻り値

false	失敗.
true	成功.

TnbUsbHidPathName.h の 920 行目に定義があります。

GetOutputReportByteLength()

size_t GetOutputReportByteLength

(

void

)

const

[取得] Outputレポート長取得

戻り値

Outputレポート長。

TnbUsbHidPathName.h の 843 行目に定義があります。

GetPathName()

const CStr & GetPathName

(

void

)

const

[取得] パスネーム取得

戻り値

パスネーム。

TnbUsbHidPathName.h の 807 行目に定義があります。

GetProductId()

WORD GetProductId

(

void

)

const

[取得] プロダクトID取得

戻り値

プロダクトID。

TnbUsbHidPathName.h の 825 行目に定義があります。

GetValueCaps()

bool GetValueCaps	(	CWorkMemT< HIDP_VALUE_CAPS > &	_vn,
		HIDP_REPORT_TYPE	reportType
	)

[設定] 値性能情報取得.

引数

[out]	_vn	成功時情報が格納されます。
[in]	reportType	レポートタイプ

戻り値

true	成功。
false	失敗

TnbUsbHidPathName.h の 760 行目に定義があります。

GetVendorId()

WORD GetVendorId

(

void

)

const

[取得] ベンダID取得

戻り値

ベンダID。

TnbUsbHidPathName.h の 816 行目に定義があります。

IsEmpty()

bool IsEmpty

(

void

)

const

[確認] 情報有無確認

戻り値

true	空っぽ
false	情報あり

TnbUsbHidPathName.h の 615 行目に定義があります。

SetPathName()

DWORD SetPathName

(

LPCTSTR

lpszPathName

)

[設定] パスネーム設定.

指定のパスネームを使い、USB-HIDデバイスをアクセスし、 Vendor ID,Product ID,Capability を取得し、本インスタンスに設定します。

覚え書き

パスネームだけの設定ではありません。

引数

lpszPathName

パスネーム。

戻り値

ERROR_SUCCESS	成功。本インスタンスに情報が格納されています。
上記以外	失敗。戻り値はエラーコード。本インスタンスは、情報無し状態になります。

TnbUsbHidPathName.h の 644 行目に定義があります。

ToString()

CStr ToString

(

void

)

const

[取得] 文字列取得.

覚え書き

VID PID などを含む文字列を返します。

戻り値

文字列。

TnbUsbHidPathName.h の 958 行目に定義があります。