função HidP_UnsetUsages (hidpi.h)
A rotina HidP_UnsetUsages define os usos do botão de controle HID especificados OFF (zero) em um relatório HID.
Sintaxe
NTSTATUS HidP_UnsetUsages(
[in] HIDP_REPORT_TYPE ReportType,
[in] USAGE UsagePage,
[in, optional] USHORT LinkCollection,
[in, out] PUSAGE UsageList,
[in, out] PULONG UsageLength,
[in] PHIDP_PREPARSED_DATA PreparsedData,
[in] PCHAR Report,
[in] ULONG ReportLength
);
Parâmetros
[in] ReportType
Especifica um valor HIDP_REPORT_TYPE enumerador que indica o tipo de relatório localizado em Relatório.
[in] UsagePage
Especifica a página de uso dos usos especificados por UsageList.
[in, optional] LinkCollection
Especifica a coleção de links que contém os usos. Se LinkCollection for diferente de zero, a rotina definirá apenas os usos, se existirem, nesta coleção de links. Se LinkCollection for zero, a rotina definirá o primeiro uso para cada uso encontrado na coleção de nível superior associada a PreparsedData.
[in, out] UsageList
Ponteiro para a matriz de usos a ser definida como OFF.
[in, out] UsageLength
Especifica, na entrada, o número de usos em UsageList. Consulte a seção Comentários para obter informações sobre o valor de saída.
[in] PreparsedData
Ponteiro para os dados pré-preparados da coleção de nível superior associada ao relatório localizado em Relatório.
[in] Report
Ponteiro para um relatório.
[in] ReportLength
Especifica o tamanho, em bytes, do relatório localizado em Relatório, que deve ser igual ao comprimento do relatório para o tipo de relatório especificado que HidP_GetCaps retorna na estrutura HIDP_CAPS de uma coleção.
Retornar valor
HidP_UnsetUsages retornará HIDP_STATUS_SUCCESS se definir com êxito como OFF todos os usos em UsageList.
HidP_UnsetUsages retornará um dos seguintes valores de status se um dos parâmetros de entrada não for válido:
| Código de retorno | Descrição |
|---|---|
|
Os dados pré-preparados especificados por PreparsedData não são válidos. |
|
O comprimento do relatório não é válido. |
|
O tipo de relatório não é válido. |
|
A coleção não contém um relatório do tipo especificado. |
HidP_UnsetUsages retornará um dos seguintes valores de status se não tiver sido capaz de definir como OFF um dos usos em UsageList:
| Código de retorno | Descrição |
|---|---|
|
Um uso já está definido como OFF. |
|
Um uso não está contido no relatório especificado, mas está contido em outro relatório do tipo especificado. |
|
A rotina não encontrou um uso em nenhum relatório do tipo especificado. |
Comentários
HidP_UnsetUsages define UsageLength da seguinte maneira:
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 | hidpi.h (inclua Hidpi.h) |
| Biblioteca | Hidparse.lib |
| IRQL | <=DISPATCH_LEVEL |