función WinUsb_GetPowerPolicy (winusb.h)

Artículo
08/27/2023

La función WinUsb_GetPowerPolicy recupera la directiva de energía de un dispositivo. Se trata de una operación sincrónica.

Sintaxis

BOOL WinUsb_GetPowerPolicy(
  [in]      WINUSB_INTERFACE_HANDLE InterfaceHandle,
  [in]      ULONG                   PolicyType,
  [in, out] PULONG                  ValueLength,
  [out]     PVOID                   Value
);

Parámetros

[in] InterfaceHandle

Identificador opaco de la primera interfaz del dispositivo, que devuelve WinUsb_Initialize.

[in] PolicyType

Valor que especifica el parámetro de directiva de energía que se va a recuperar en Value. En la tabla siguiente se describen las constantes simbólicas definidas en Winusbio.h.

Tipo de directiva	Descripción
AUTO_SUSPEND (0x81)	Si el autor de la llamada especifica una directiva de potencia de AUTO_SUSPEND, WinUsb_GetPowerPolicy devuelve el valor del parámetro de directiva de suspensión automática en el parámetro Value . Si Value es TRUE (es decir, distinto de cero), la pila USB suspende el dispositivo cuando no hay transferencias pendientes o las únicas transferencias pendientes son transferencias IN en un punto de conexión de interrupción o masivo. El valor del registro DefaultIdleState determina el valor predeterminado del parámetro de directiva de suspensión automática. El parámetro Value debe apuntar a una variable UCHAR.
SUSPEND_DELAY (0x83)	Si el autor de la llamada especifica una directiva de potencia de SUSPEND_DELAY, WinUsb_GetPowerPolicy devuelve el valor del parámetro de directiva de retraso de suspensión en Value. El parámetro de directiva de retraso de suspensión especifica la cantidad mínima de tiempo, en milisegundos, que el controlador WinUSB debe esperar después de cualquier transferencia antes de que pueda suspender el dispositivo. El valor debe apuntar a una variable ULONG.

Tipo de directiva

Descripción

AUTO_SUSPEND

(0x81)

Si el autor de la llamada especifica una directiva de potencia de AUTO_SUSPEND, WinUsb_GetPowerPolicy devuelve el valor del parámetro de directiva de suspensión automática en el parámetro Value .

Si Value es TRUE (es decir, distinto de cero), la pila USB suspende el dispositivo cuando no hay transferencias pendientes o las únicas transferencias pendientes son transferencias IN en un punto de conexión de interrupción o masivo.

El valor del registro DefaultIdleState determina el valor predeterminado del parámetro de directiva de suspensión automática.

El parámetro Value debe apuntar a una variable UCHAR.

SUSPEND_DELAY

(0x83)

Si el autor de la llamada especifica una directiva de potencia de SUSPEND_DELAY, WinUsb_GetPowerPolicy devuelve el valor del parámetro de directiva de retraso de suspensión en Value.

El parámetro de directiva de retraso de suspensión especifica la cantidad mínima de tiempo, en milisegundos, que el controlador WinUSB debe esperar después de cualquier transferencia antes de que pueda suspender el dispositivo.

El valor debe apuntar a una variable ULONG.

[in, out] ValueLength

Puntero al tamaño del búfer que Value. En la salida, ValueLength recibe el tamaño de los datos que se copiaron en el búfer de valor .

[out] Value

Búfer que recibe el parámetro de directiva de energía especificado. Para obtener más información, vea PolicyType.

Valor devuelto

WinUsb_GetPowerPolicy devuelve TRUE si la operación se realiza correctamente. De lo contrario, esta rutina devuelve FALSE y el autor de la llamada puede recuperar el error registrado llamando a GetLastError.

GetLastError puede devolver el siguiente código de error.