WinUsb_GetPowerPolicy-Funktion (winusb.h)

Artikel
08/27/2023

Die funktion WinUsb_GetPowerPolicy ruft die Energierichtlinie für ein Gerät ab. Dies ist ein synchroner Vorgang.

Syntax

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

Parameter

[in] InterfaceHandle

Ein undurchsichtiges Handle für die erste Schnittstelle auf dem Gerät, das von WinUsb_Initialize zurückgegeben wird.

[in] PolicyType

Ein -Wert, der den power policy-Parameter angibt, der in Value abgerufen werden soll. In der folgenden Tabelle werden symbolische Konstanten beschrieben, die in Winusbio.h definiert sind.

Richtlinientyp	BESCHREIBUNG
AUTO_SUSPEND (0x81)	Wenn der Aufrufer eine Energierichtlinie von AUTO_SUSPEND angibt, gibt WinUsb_GetPowerPolicy den Wert des Richtlinienparameters für automatisches Anhalten im Value-Parameter zurück. Wenn Der WertTRUE (d. h. ungleich null) ist, wird das Gerät vom USB-Stapel angehalten, wenn keine Übertragungen ausstehen oder die einzigen ausstehenden Übertragungen IN-Übertragungen an einem Interrupt- oder Massenendpunkt sind. Der Wert des DefaultIdleState-Registrierungswerts bestimmt den Standardwert des Richtlinienparameters für automatisches Anhalten. Der Value-Parameter muss auf eine UCHAR-Variable verweisen.
SUSPEND_DELAY (0x83)	Wenn der Aufrufer eine Energierichtlinie von SUSPEND_DELAY angibt, gibt WinUsb_GetPowerPolicy den Wert des Richtlinienparameters für die Verzögerung angehalten in Value zurück. Der Richtlinienparameter für die Verzögerung anhalten gibt die Mindestdauer in Millisekunden an, die der WinUSB-Treiber nach jeder Übertragung warten muss, bevor er das Gerät anhalten kann. Der Wert muss auf eine ULONG-Variable verweisen.

Richtlinientyp

BESCHREIBUNG

AUTO_SUSPEND

(0x81)

Wenn der Aufrufer eine Energierichtlinie von AUTO_SUSPEND angibt, gibt WinUsb_GetPowerPolicy den Wert des Richtlinienparameters für automatisches Anhalten im Value-Parameter zurück.

Wenn Der WertTRUE (d. h. ungleich null) ist, wird das Gerät vom USB-Stapel angehalten, wenn keine Übertragungen ausstehen oder die einzigen ausstehenden Übertragungen IN-Übertragungen an einem Interrupt- oder Massenendpunkt sind.

Der Wert des DefaultIdleState-Registrierungswerts bestimmt den Standardwert des Richtlinienparameters für automatisches Anhalten.

Der Value-Parameter muss auf eine UCHAR-Variable verweisen.

SUSPEND_DELAY

(0x83)

Wenn der Aufrufer eine Energierichtlinie von SUSPEND_DELAY angibt, gibt WinUsb_GetPowerPolicy den Wert des Richtlinienparameters für die Verzögerung angehalten in Value zurück.

Der Richtlinienparameter für die Verzögerung anhalten gibt die Mindestdauer in Millisekunden an, die der WinUSB-Treiber nach jeder Übertragung warten muss, bevor er das Gerät anhalten kann.

Der Wert muss auf eine ULONG-Variable verweisen.

[in, out] ValueLength

Ein Zeiger auf die Größe des Puffers, der wert ist. Bei der Ausgabe empfängt ValueLength die Größe der Daten, die in den Wertpuffer kopiert wurden.

[out] Value

Ein Puffer, der den angegebenen Energierichtlinienparameter empfängt. Weitere Informationen finden Sie unter PolicyType.

Rückgabewert

WinUsb_GetPowerPolicy gibt TRUE zurück, wenn der Vorgang erfolgreich ist. Andernfalls gibt diese Routine FALSE zurück, und der Aufrufer kann den protokollierten Fehler durch Aufrufen von GetLastError abrufen.

GetLastError kann den folgenden Fehlercode zurückgeben.