WinUsb_GetPipePolicy-Funktion (winusb.h)

Artikel
08/27/2023

Die funktion WinUsb_GetPipePolicy ruft die Richtlinie für eine bestimmte Pipe ab, die einem Endpunkt auf dem Gerät zugeordnet ist. Dies ist ein synchroner Vorgang.

Syntax

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

Parameter

[in] InterfaceHandle

Ein undurchsichtiges Handle für eine Schnittstelle, die den Endpunkt enthält, dem die Pipe zugeordnet ist.

Um die Pipe abzufragen, die dem Endpunkt in der ersten Schnittstelle zugeordnet ist, verwenden Sie das von WinUsb_Initialize zurückgegebene Handle. Verwenden Sie für alle anderen Schnittstellen das Handle für die Zielschnittstelle, das von WinUsb_GetAssociatedInterface abgerufen wird.

[in] PipeID

Ein 8-Bit-Wert, der aus einer 7-Bit-Adresse und einem Richtungsbit besteht. Dieser Parameter entspricht dem Feld bEndpointAddress im Endpunktdeskriptor.

[in] PolicyType

Eine ULONG-Variable , die den abzurufenden Richtlinienparameter angibt. Der aktuelle Wert für den Richtlinienparameter wird mit dem Value-Parameter abgerufen. Informationen zum Verhalten der Piperichtlinien finden Sie unter WinUSB Functions for Pipe Policy Modification.

[in, out] ValueLength

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

[out] Value

Ein Zeiger auf einen Puffer, der den angegebenen Piperichtlinienwert empfängt.

Rückgabewert

WinUsb_GetPipePolicy 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.