HidP_GetData 함수(hidpi.h)

  • 아티클

HidP_GetData 루틴은 지정된 보고서에 대해 현재 ON(1)으로 설정된 모든 HID 컨트롤 단추의 데이터 인덱스를 식별하는 HIDP_DATA 구조의 배열과 모든 HID 컨트롤 값과 연결된 데이터 인덱스 및 데이터를 반환합니다.

구문

NTSTATUS HidP_GetData(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_DATA           DataList,
  [in, out] PULONG               DataLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

매개 변수

[in] ReportType

보고서에 있는 HID 보고서의 형식을 나타내는 HIDP_REPORT_TYPE 열거자 값을 지정합니다.

[out] DataList

루틴이 현재 ON으로 설정된 모든 단추 및 값과 연결된 데이터에 대한 정보를 반환하는 데 사용하는 HIDP_DATA 구조체의 호출자 할당 배열을 지정합니다.

[in, out] DataLength

입력에서 호출자가 할당한 DataList 배열이 보유하는 구조의 수를 지정합니다. 출력에서 루틴이 데이터를 반환할 수 있는 컨트롤 수를 지정합니다. 여기에는 현재 ON으로 설정된 모든 단추와 모든 컨트롤 값이 포함됩니다.

[in] PreparsedData

보고서에 있는 HID 보고서와 연결된 최상위 컬렉션의 준비 데이터에 대한 포인터입니다.

[in] Report

HID 보고서에 대한 포인터입니다.

[in] ReportLength

보고서에 있는 HID 보고서의 크기(바이트)를 지정합니다. 이 크기는 컬렉션의 HIDP_CAPS 구조에서 HidP_GetCaps 반환한 지정된 보고서 형식의 보고서 길이와 같아야 합니다.

반환 값

HidP_GetData 다음 상태 값 중 하나를 반환합니다.

반환 코드 설명
HIDP_STATUS_SUCCESS
 모든 컨트롤 데이터가 성공적으로 반환되었습니다.
HIDP_STATUS_INVALID_REPORT_TYPE
 ReportType에 지정된 보고서 형식이 잘못되었습니다.
HIDP_STATUS_INVALID_PREPARSED_DATA
 PreparsedData에서 지정한 준비 데이터가 잘못되었습니다.
HIDP_STATUS_INVALID_REPORT_LENGTH
 HID 보고서의 크기(바이트)는 지정된 보고서 형식에 대한 컬렉션의 HIDP_CAPS 구조에 지정된 길이와 같지 않습니다.
HIDP_STATUS_REPORT_DOES_NOT_EXIST
 최상위 컬렉션에는 지정된 형식의 보고서가 없습니다.
HIDP_STATUS_BUFFER_TOO_SMALL
 DataList 배열이 너무 작아서 현재 ON으로 설정된 모든 단추와 HID 보고서의 모든 값을 설명할 수 없습니다.

설명

사용자 모드 애플리케이션 및 커널 모드 드라이버는 HidP_MaxDataListLength 호출하여 HidP_GetData 반환 할 수 있는 최대 HIDP_DATA 구조 수를 결정합니다.

HidP_GetData사용량 값 배열에 대한 데이터를 반환하지 않습니다.

자세한 내용은 HID 컬렉션을 참조하세요.

요구 사항

요구 사항 값
지원되는 최소 클라이언트 Windows 2000 이상 버전의 Windows에서 사용할 수 있습니다.
대상 플랫폼 유니버설
헤더 hidpi.h(Hidpi.h 포함)
라이브러리 Hidparse.lib
IRQL <= DISPATCH_LEVEL

추가 정보

HIDP_DATA

HidP_MaxDataListLength

HidP_SetData

_HIDP_PREPARSED_DATA