hid.dll アクセスクラス [詳解]

#include <TnbUsbHidPathName.h>

CUsbHidApi の継承関係図

公開メンバ関数
	CUsbHidApi (const CUsbHidApi &other)
	コピーコンストラクタ. [詳解]

	CUsbHidApi (void)
	コンストラクタ [詳解]

BOOLEAN	HidD_FlushQueue (HANDLE hidDeviceObject)
	[処理] キューフラッシュ. [詳解]

BOOLEAN	HidD_FreePreparsedData (PHIDP_PREPARSED_DATA pPreparsedData) const
	[開放] PREPARSEDデータ開放. [詳解]

BOOLEAN	HidD_GetAttributes (HANDLE hidDeviceObject, PHIDD_ATTRIBUTES pAttributes) const
	[取得] 属性取得. [詳解]

BOOLEAN	HidD_GetFeature (HANDLE hidDeviceObject, PVOID pReportBuffer, ULONG reportBufferLength) const
	[受信] 機能レポート受信 [詳解]

void	HidD_GetHidGuid (LPGUID pHidGuid) const
	[取得] HID GUID 取得. [詳解]

BOOLEAN	HidD_GetIndexedString (HANDLE hidDeviceObject, ULONG stringIndex, PVOID pBuffer, ULONG bufferLength) const
	[取得] INDEXED 文字列取得 [詳解]

BOOLEAN	HidD_GetInputReport (HANDLE hidDeviceObject, PVOID pReportBuffer, ULONG reportBufferLength) const
	[受信] Inputレポート受信 [詳解]

BOOLEAN	HidD_GetManufacturerString (HANDLE hidDeviceObject, PVOID pBuffer, ULONG bufferLength) const
	[取得] Manufacturer 文字列取得 [詳解]

BOOLEAN	HidD_GetNumInputBuffers (HANDLE hidDeviceObject, PULONG pNumberBuffers) const
	[取得] 入力バッファ数取得. [詳解]

BOOLEAN	HidD_GetPreparsedData (HANDLE hidDeviceObject, PHIDP_PREPARSED_DATA *ppPreparsedData) const
	[取得] PREPARSEDデータ取得. [詳解]

BOOLEAN	HidD_GetProductString (HANDLE hidDeviceObject, PVOID pBuffer, ULONG bufferLength) const
	[取得] Product 文字列取得 [詳解]

BOOLEAN	HidD_GetSerialNumberString (HANDLE hidDeviceObject, PVOID pBuffer, ULONG bufferLength) const
	[取得] SerialNumber 文字列取得 [詳解]

BOOLEAN	HidD_SetFeature (HANDLE hidDeviceObject, PVOID pReportBuffer, ULONG reportBufferLength)
	[送信] 機能レポート送信 [詳解]

BOOLEAN	HidD_SetNumInputBuffers (HANDLE hidDeviceObject, ULONG numberBuffers)
	[設定] 入力バッファ数設定. [詳解]

BOOLEAN	HidD_SetOutputReport (HANDLE hidDeviceObject, PVOID pReportBuffer, ULONG reportBufferLength)
	[送信] Outputレポート送信 [詳解]

NTSTATUS	HidP_GetButtonCaps (HIDP_REPORT_TYPE reportType, PHIDP_BUTTON_CAPS pButtonCaps, PUSHORT pButtonCapsLength, PHIDP_PREPARSED_DATA pPreparsedData)
	[取得] ボタン性能取得. [詳解]

NTSTATUS	HidP_GetCaps (PHIDP_PREPARSED_DATA pPreparsedData, PHIDP_CAPS pCapabilities) const
	[取得] 能力取得. [詳解]

NTSTATUS	HidP_GetLinkCollectionNodes (PHIDP_LINK_COLLECTION_NODE pLinkCollectionNodes, PULONG pLinkCollectionNodesLength, PHIDP_PREPARSED_DATA pPreparsedData)
	[取得] リンクコレクションノード取得. [詳解]

NTSTATUS	HidP_GetSpecificButtonCaps (HIDP_REPORT_TYPE reportType, USAGE usagePage, USHORT linkCollection, USAGE usage, PHIDP_BUTTON_CAPS pButtonCaps, PUSHORT pButtonCapsLength, PHIDP_PREPARSED_DATA pPreparsedData)
	[取得] ボタン詳細性能取得. [詳解]

NTSTATUS	HidP_GetSpecificValueCaps (HIDP_REPORT_TYPE reportType, USAGE usagePage, USHORT linkCollection, USAGE usage, PHIDP_VALUE_CAPS pValueCaps, PUSHORT pValueCapsLength, PHIDP_PREPARSED_DATA pPreparsedData)
	[取得] 値詳細性能取得. [詳解]

NTSTATUS	HidP_GetValueCaps (HIDP_REPORT_TYPE reportType, PHIDP_VALUE_CAPS pValueCaps, PUSHORT pValueCapsLength, PHIDP_PREPARSED_DATA pPreparsedData)
	[取得] 値性能取得. [詳解]

CUsbHidApi &	operator= (const CUsbHidApi &other)
	コピーオペレータ [詳解]

	~CUsbHidApi (void)
	デストラクタ [詳解]

詳解

hid.dll アクセスクラス

hid.dll を動的にリンクし、そのメソッドをアクセスできます。
これにより、 DDK(WDK)がなくても、 HID 関係の API を使用することが出来ます。

hid.dll が持っているメソッドと同じものを持っています。

必要ファイル: TnbUsbHidPathName.h

日付: 10/02/04 新規作成; 10/03/17 GetString系メソッド等、追加。　; 13/01/08 HidD_SetOutputReport(), HidD_GetInputReport(), 追加。

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

構築子と解体子

◆ CUsbHidApi() [1/2]

CUsbHidApi ( void )

コンストラクタ

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

◆ CUsbHidApi() [2/2]

CUsbHidApi ( const CUsbHidApi & other )

コピーコンストラクタ.

覚え書き: 何もコピーしません

引数

other コピー元

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

◆ ~CUsbHidApi()

~CUsbHidApi ( void )

デストラクタ

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

関数詳解

◆ HidD_FlushQueue()

BOOLEAN HidD_FlushQueue ( HANDLE hidDeviceObject )

[処理] キューフラッシュ.

引数

[in] hidDeviceObject HIDデバイスをオープンしたハンドル.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_FreePreparsedData()

BOOLEAN HidD_FreePreparsedData ( PHIDP_PREPARSED_DATA pPreparsedData ) const

[開放] PREPARSEDデータ開放.

HidD_GetPreparsedData() で取得したデータの開放を行います。

引数

[in] pPreparsedData HidD_GetPreparsedData() で獲得した PREPARSEDデータのポインタ.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_GetAttributes()

BOOLEAN HidD_GetAttributes	(	HANDLE	hidDeviceObject,
		PHIDD_ATTRIBUTES	pAttributes
	)		const

[取得] 属性取得.

引数

[in]	hidDeviceObject	HIDデバイスをオープンしたハンドル.
[out]	pAttributes	取得した属性が格納されます.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_GetFeature()

BOOLEAN HidD_GetFeature	(	HANDLE	hidDeviceObject,
		PVOID	pReportBuffer,
		ULONG	reportBufferLength
	)		const

[受信] 機能レポート受信

引数

[in]	hidDeviceObject	HIDデバイスをオープンしたハンドル.
[out]	pReportBuffer	受信したレポート内容が格納されるバッファです.
[in]	reportBufferLength	受信バッファ長さ.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_GetHidGuid()

void HidD_GetHidGuid ( LPGUID pHidGuid ) const

[取得] HID GUID 取得.

引数

[out] pHidGuid 取得した GUID が格納されます。

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

◆ HidD_GetIndexedString()

BOOLEAN HidD_GetIndexedString	(	HANDLE	hidDeviceObject,
		ULONG	stringIndex,
		PVOID	pBuffer,
		ULONG	bufferLength
	)		const

[取得] INDEXED 文字列取得

引数

[in]	hidDeviceObject	HIDデバイスをオープンしたハンドル.
[in]	stringIndex	インデックス
[out]	pBuffer	受信した文字列が格納されるバッファです.
[in]	bufferLength	バッファ長さ.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_GetInputReport()

BOOLEAN HidD_GetInputReport	(	HANDLE	hidDeviceObject,
		PVOID	pReportBuffer,
		ULONG	reportBufferLength
	)		const

[受信] Inputレポート受信

引数

[in]	hidDeviceObject	HIDデバイスをオープンしたハンドル.
[out]	pReportBuffer	受信したレポート内容が格納されるバッファです.
[in]	reportBufferLength	受信バッファ長さ.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_GetManufacturerString()

BOOLEAN HidD_GetManufacturerString	(	HANDLE	hidDeviceObject,
		PVOID	pBuffer,
		ULONG	bufferLength
	)		const

[取得] Manufacturer 文字列取得

引数

[in]	hidDeviceObject	HIDデバイスをオープンしたハンドル.
[out]	pBuffer	受信した文字列が格納されるバッファです.
[in]	bufferLength	バッファ長さ.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_GetNumInputBuffers()

BOOLEAN HidD_GetNumInputBuffers	(	HANDLE	hidDeviceObject,
		PULONG	pNumberBuffers
	)		const

[取得] 入力バッファ数取得.

引数

[in]	hidDeviceObject	HIDデバイスをオープンしたハンドル.
[out]	pNumberBuffers	入力バッファ数が格納されるバッファです.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_GetPreparsedData()

BOOLEAN HidD_GetPreparsedData	(	HANDLE	hidDeviceObject,
		PHIDP_PREPARSED_DATA *	ppPreparsedData
	)		const

[取得] PREPARSEDデータ取得.

引数

[in]	hidDeviceObject	HIDデバイスをオープンしたハンドル.
[out]	ppPreparsedData	取得した PREPARSEDデータが格納されているポインタが格納されます. 使用後は必ず、 HidD_FreePreparsedData() で開放してください。

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_GetProductString()

BOOLEAN HidD_GetProductString	(	HANDLE	hidDeviceObject,
		PVOID	pBuffer,
		ULONG	bufferLength
	)		const

[取得] Product 文字列取得

引数

[in]	hidDeviceObject	HIDデバイスをオープンしたハンドル.
[out]	pBuffer	受信した文字列が格納されるバッファです.
[in]	bufferLength	バッファ長さ.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_GetSerialNumberString()

BOOLEAN HidD_GetSerialNumberString	(	HANDLE	hidDeviceObject,
		PVOID	pBuffer,
		ULONG	bufferLength
	)		const

[取得] SerialNumber 文字列取得

引数

[in]	hidDeviceObject	HIDデバイスをオープンしたハンドル.
[out]	pBuffer	受信した文字列が格納されるバッファです.
[in]	bufferLength	バッファ長さ.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_SetFeature()

BOOLEAN HidD_SetFeature	(	HANDLE	hidDeviceObject,
		PVOID	pReportBuffer,
		ULONG	reportBufferLength
	)

[送信] 機能レポート送信

引数

[in]	hidDeviceObject	HIDデバイスをオープンしたハンドル.
[in]	pReportBuffer	レポート内容.
[in]	reportBufferLength	レポート長さ.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_SetNumInputBuffers()

BOOLEAN HidD_SetNumInputBuffers	(	HANDLE	hidDeviceObject,
		ULONG	numberBuffers
	)

[設定] 入力バッファ数設定.

引数

hidDeviceObject	HIDデバイスをオープンしたハンドル.
numberBuffers	入力バッファ数.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidD_SetOutputReport()

BOOLEAN HidD_SetOutputReport	(	HANDLE	hidDeviceObject,
		PVOID	pReportBuffer,
		ULONG	reportBufferLength
	)

[送信] Outputレポート送信

引数

[in]	hidDeviceObject	HIDデバイスをオープンしたハンドル.
[in]	pReportBuffer	レポート内容.
[in]	reportBufferLength	レポート長さ.

戻り値

TRUE	成功.
FALSE	失敗.

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

◆ HidP_GetButtonCaps()

NTSTATUS HidP_GetButtonCaps	(	HIDP_REPORT_TYPE	reportType,
		PHIDP_BUTTON_CAPS	pButtonCaps,
		PUSHORT	pButtonCapsLength,
		PHIDP_PREPARSED_DATA	pPreparsedData
	)

[取得] ボタン性能取得.

引数

[in]	reportType	レポートタイプ
[out]	pButtonCaps	ボタン性能情報の配列
[in,out]	pButtonCapsLength	in でボタン性能情報の配列数。 out で取得した数が返ります。
[in]	pPreparsedData	PREPARSEDデータ.

戻り値

HIDP_STATUS_SUCCESS	成功.
上記以外	失敗.

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

◆ HidP_GetCaps()

NTSTATUS HidP_GetCaps	(	PHIDP_PREPARSED_DATA	pPreparsedData,
		PHIDP_CAPS	pCapabilities
	)		const

[取得] 能力取得.

引数

[in]	pPreparsedData	PREPARSEDデータ.
[out]	pCapabilities	取得した能力データが格納されます。

戻り値

HIDP_STATUS_SUCCESS	成功.
上記以外	失敗.

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

◆ HidP_GetLinkCollectionNodes()

NTSTATUS HidP_GetLinkCollectionNodes	(	PHIDP_LINK_COLLECTION_NODE	pLinkCollectionNodes,
		PULONG	pLinkCollectionNodesLength,
		PHIDP_PREPARSED_DATA	pPreparsedData
	)

[取得] リンクコレクションノード取得.

引数

[out]	pLinkCollectionNodes	ノード情報の配列
[in,out]	pLinkCollectionNodesLength	in でノード情報の配列数。 out で取得した数が返ります。
[in]	pPreparsedData	PREPARSEDデータ.

戻り値

HIDP_STATUS_SUCCESS	成功.
上記以外	失敗.

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

◆ HidP_GetSpecificButtonCaps()

NTSTATUS HidP_GetSpecificButtonCaps	(	HIDP_REPORT_TYPE	reportType,
		USAGE	usagePage,
		USHORT	linkCollection,
		USAGE	usage,
		PHIDP_BUTTON_CAPS	pButtonCaps,
		PUSHORT	pButtonCapsLength,
		PHIDP_PREPARSED_DATA	pPreparsedData
	)

[取得] ボタン詳細性能取得.

引数

[in]	reportType	レポートタイプ
[in]	usagePage	USAGE PAGE
[in]	linkCollection	LINK COLLECTION
[in]	usage	USAGE
[out]	pButtonCaps	ボタン性能情報の配列
[in,out]	pButtonCapsLength	in でボタン性能情報の配列数。 out で取得した数が返ります。
[in]	pPreparsedData	PREPARSEDデータ.

戻り値

HIDP_STATUS_SUCCESS	成功.
上記以外	失敗.

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

◆ HidP_GetSpecificValueCaps()

NTSTATUS HidP_GetSpecificValueCaps	(	HIDP_REPORT_TYPE	reportType,
		USAGE	usagePage,
		USHORT	linkCollection,
		USAGE	usage,
		PHIDP_VALUE_CAPS	pValueCaps,
		PUSHORT	pValueCapsLength,
		PHIDP_PREPARSED_DATA	pPreparsedData
	)

[取得] 値詳細性能取得.

引数

[in]	reportType	レポートタイプ
[in]	usagePage	USAGE PAGE
[in]	linkCollection	LINK COLLECTION
[in]	usage	USAGE
[out]	pValueCaps	値性能情報の配列
[in,out]	pValueCapsLength	in で値性能情報の配列数。 out で取得した数が返ります。
[in]	pPreparsedData	PREPARSEDデータ.

戻り値

HIDP_STATUS_SUCCESS	成功.
上記以外	失敗.

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

◆ HidP_GetValueCaps()

NTSTATUS HidP_GetValueCaps	(	HIDP_REPORT_TYPE	reportType,
		PHIDP_VALUE_CAPS	pValueCaps,
		PUSHORT	pValueCapsLength,
		PHIDP_PREPARSED_DATA	pPreparsedData
	)

[取得] 値性能取得.

引数

[in]	reportType	レポートタイプ
[out]	pValueCaps	値性能情報の配列
[in,out]	pValueCapsLength	in で値性能情報の配列数。 out で取得した数が返ります。
[in]	pPreparsedData	PREPARSEDデータ.

戻り値

HIDP_STATUS_SUCCESS	成功.
上記以外	失敗.

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

◆ operator=()

CUsbHidApi & operator= ( const CUsbHidApi & other )

コピーオペレータ

覚え書き: 何もコピーしません

引数

other コピー元.

戻り値: 自分の参照

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

公開メンバ関数

詳解

構築子と解体子

◆ CUsbHidApi() [1/2]

◆ CUsbHidApi() [2/2]

◆ ~CUsbHidApi()

関数詳解

◆ HidD_FlushQueue()

◆ HidD_FreePreparsedData()

◆ HidD_GetAttributes()

◆ HidD_GetFeature()

◆ HidD_GetHidGuid()

◆ HidD_GetIndexedString()

◆ HidD_GetInputReport()

◆ HidD_GetManufacturerString()

◆ HidD_GetNumInputBuffers()

◆ HidD_GetPreparsedData()

◆ HidD_GetProductString()

◆ HidD_GetSerialNumberString()

◆ HidD_SetFeature()

◆ HidD_SetNumInputBuffers()

◆ HidD_SetOutputReport()

◆ HidP_GetButtonCaps()

◆ HidP_GetCaps()

◆ HidP_GetLinkCollectionNodes()

◆ HidP_GetSpecificButtonCaps()

◆ HidP_GetSpecificValueCaps()

◆ HidP_GetValueCaps()

◆ operator=()