Método IWDFUsbTargetDevice::RetrievePowerPolicy (wudfusb.h)

[Aviso: UMDF 2 é a versão mais recente do UMDF e substitui UMDF 1. Todos os novos drivers UMDF devem ser gravados usando UMDF 2. Nenhum novo recurso está sendo adicionado ao UMDF 1 e há suporte limitado para UMDF 1 em versões mais recentes do Windows 10. Drivers universais do Windows devem usar UMDF 2. Para obter mais informações, consulte Introdução com UMDF.]

O método RetrievePowerPolicy recupera uma política de energia do WinUsb.

Sintaxe

HRESULT RetrievePowerPolicy(
  [in]      ULONG PolicyType,
  [in, out] ULONG *ValueLength,
  [out]     PVOID Value
);

Parâmetros

[in] PolicyType

O tipo de política de energia do WinUsb que o driver UMDF solicita.

[in, out] ValueLength

Um ponteiro para uma variável que, na entrada, contém o tamanho, em bytes, do buffer que RetrievePowerPolicy fornece em Value. Na saída, esse parâmetro contém o tamanho que RetrievePowerPolicy requer para Value.

[out] Value

Um ponteiro que recebe o buffer que contém a política de energia do WinUsb.

Retornar valor

RetrievePowerPolicy retorna um dos seguintes valores:

Código de retorno	Descrição
S_OK	RetrievePowerPolicy recuperou com êxito a política de energia do WinUsb.
E_OUTOFMEMORY	RetrievePowerPolicy encontrou uma falha de alocação.
Um código de erro definido em Winerror.h	Esse valor corresponde ao código de erro retornado pela API do WinUsb.

Comentários

A política de energia controla o gerenciamento de energia que o WinUsb para o dispositivo executa.

Para obter informações sobre tipos de política válidos que um driver UMDF pode passar para o parâmetro PolicyType e os valores retornados pela estrutura, consulte a função WinUsb_GetPowerPolicy .

Para obter mais informações sobre o comportamento de energia do WinUSB, consulte Gerenciamento de Energia do WinUSB.

O método RetrievePowerPolicy gera uma solicitação UMDF e envia a solicitação de forma síncrona para o destino de E/S.

Requisitos

Requisito	Valor
Fim do suporte	Indisponível no UMDF 2.0 e posterior.
Plataforma de Destino	Área de Trabalho
Versão mínima do UMDF	1.5
Cabeçalho	wudfusb.h (include Wudfusb.h)
DLL	WUDFx.dll

Confira também

IWDFUsbTargetDevice

IWDFUsbTargetDevice::SetPowerPolicy

WinUsb_GetPowerPolicy