Função GetRawInputDeviceInfoA (winuser.h)

Artigo
11/20/2024

Recupera informações sobre o dispositivo de entrada bruta.

Sintaxe

UINT GetRawInputDeviceInfoA(
  [in, optional]      HANDLE hDevice,
  [in]                UINT   uiCommand,
  [in, out, optional] LPVOID pData,
  [in, out]           PUINT  pcbSize
);

Parâmetros

[in, optional] hDevice

Tipo: HANDLE

Um identificador para o dispositivo de entrada bruto. Isso vem do membro do RAWINPUTHEADER ou de GetRawInputDeviceList.

[in] uiCommand

Tipo: UINT

Especifica quais dados serão retornados em pData. Esse parâmetro pode ser um dos valores a seguir.

Valor	Significado
RIDI_PREPARSEDDATA 0x20000005	pData é um ponteiro PHIDP_PREPARSED_DATA para um buffer para dados pré-preparados de uma coleção de nível superior.
RIDI_DEVICENAME 0x20000007	pData aponta para uma cadeia de caracteres que contém o nome da interface do dispositivo . Se esse dispositivo for aberto com o Modo de Acesso Compartilhado, você poderá chamar CreateFile com esse nome para abrir uma coleção HID e usar o identificador retornado para chamar ReadFile para ler relatórios de entrada e WriteFile para enviar relatórios de saída. Para obter mais informações, consulte Abertura de coleções HID e manipulação de relatórios HID. Para este somente uiCommand, o valor em pcbSize é a contagem de caracteres (não a contagem de bytes).
RIDI_DEVICEINFO 0x2000000b	pData aponta para uma estrutura RID_DEVICE_INFO.

Valor

Significado

RIDI_PREPARSEDDATA
0x20000005

pData é um ponteiro PHIDP_PREPARSED_DATA para um buffer para dados pré-preparados de uma coleção de nível superior.

RIDI_DEVICENAME
0x20000007

pData aponta para uma cadeia de caracteres que contém o nome da interface do dispositivo .

Se esse dispositivo for aberto com o Modo de Acesso Compartilhado, você poderá chamar CreateFile com esse nome para abrir uma coleção HID e usar o identificador retornado para chamar ReadFile para ler relatórios de entrada e WriteFile para enviar relatórios de saída.

Para obter mais informações, consulte Abertura de coleções HID e manipulação de relatórios HID.

Para este somente uiCommand, o valor em pcbSize é a contagem de caracteres (não a contagem de bytes).

RIDI_DEVICEINFO
0x2000000b

pData aponta para uma estrutura RID_DEVICE_INFO.

[in, out, optional] pData

Tipo: LPVOID

Um ponteiro para um buffer que contém as informações especificadas por uiCommand.

Se uiCommand for RIDI_DEVICEINFO, defina o cbSize membro do RID_DEVICE_INFO para sizeof(RID_DEVICE_INFO) antes de chamar GetRawInputDeviceInfo.

[in, out] pcbSize

Tipo: PUINT

O tamanho, em bytes, dos dados em pData.

Valor de retorno

Tipo: UINT

Se bem-sucedida, essa função retornará um número não negativo indicando o número de bytes copiados para pData.

Se pData não for grande o suficiente para os dados, a função retornará -1. Se pData for NULL, a função retornará um valor igual a zero. Em ambos os casos, pcbSize é definido como o tamanho mínimo necessário para o buffer de pData .

Chame GetLastError para identificar outros erros.

Observações

Nota

O cabeçalho winuser.h define GetRawInputDeviceInfo como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	winuser.h (inclua Windows.h)
biblioteca	User32.lib
de DLL	User32.dll
conjunto de API	ext-ms-win-ntuser-rawinput-l1-1-0 (introduzido no Windows 10, versão 10.0.14393)