Compartilhar via


função HidD_GetProductString (hidsdi.h)

A rotina HidD_GetProductString retorna a cadeia de caracteres inserida de uma coleção de nível superior que identifica o produto do fabricante.

Sintaxe

BOOLEAN HidD_GetProductString(
  [in]  HANDLE HidDeviceObject,
  [out] PVOID  Buffer,
  [in]  ULONG  BufferLength
);

Parâmetros

[in] HidDeviceObject

Especifica um identificador aberto para uma coleção de nível superior.

[out] Buffer

Ponteiro para um buffer alocado pelo chamador que a rotina usa para retornar a cadeia de caracteres do produto solicitada. A rotina retorna uma cadeia de caracteres largos terminada em NULL.

[in] BufferLength

Especifica o comprimento, em bytes, de um buffer alocado pelo chamador fornecido em Buffer. Se o buffer não for grande o suficiente para retornar toda a cadeia de caracteres inserida terminada em NULL, a rotina não retornará nada no buffer. O buffer fornecido deve ser <= 4093 bytes (2^12 – 3).

Retornar valor

HidD_GetProductStringretornará TRUE se retornar com êxito toda a cadeia de caracteres inserida terminada em NULL. Caso contrário, a rotina retornará FALSE. Use GetLastError para obter informações de erro estendidas.

Comentários

Somente aplicativos no modo de usuário podem chamar HidD_GetProductString. Os drivers no modo kernel podem usar uma solicitação de IOCTL_HID_GET_PRODUCT_STRING .

O número máximo possível de caracteres em uma cadeia de caracteres inserida é específico do dispositivo. Para dispositivos USB, o comprimento máximo da cadeia de caracteres é de 126 caracteres largos (sem incluir o caractere NULL de terminação).

O membro iProduct de uma estrutura de USB_DEVICE_DESCRIPTOR para uma interface específica é definido pelo driver pai genérico de classe comum USB com base nas seguintes regras:

  • Se o membro iInterface da estrutura USB_INTERFACE_DESCRIPTOR da interface for diferente de zero, o membro iProduct da estrutura de USB_DEVICE_DESCRIPTOR da interface será definido como o membro iInterface da estrutura USB_INTERFACE_DESCRIPTOR.

  • Se a interface for agrupada por um descritor de associação de interface USB e o membro iFunction do descritor de associação de interface para a interface for diferente de zero, o membro iProduct da estrutura de USB_DEVICE_DESCRIPTOR da interface será definido como o membro iFunction do descritor de associação de interface.

Se o buffer fornecido não <for = 4093 bytes (2^12 – 3), a chamada poderá falhar (dependendo do protocolo subjacente, HID/Bluetooth/SPI) com o código de erro ERROR_GEN_FAILURE (0x0000001f)

Para obter mais informações, consulte Coleções HID.

Requisitos

Requisito Valor
Cliente mínimo com suporte Disponível no Windows 2000 e versões posteriores do Windows.
Plataforma de Destino Universal
Cabeçalho hidsdi.h (inclua Hidsdi.h)
Biblioteca Hid.lib
DLL Hid.dll

Confira também

HidD_GetIndexedString

HidD_GetPhysicalDescriptor

HidD_GetSerialNumberString

IOCTL_HID_GET_INDEXED_STRING

IOCTL_HID_GET_MANUFACTURER_STRING

IOCTL_HID_GET_PRODUCT_STRING

IOCTL_HID_GET_SERIALNUMBER_STRING