HWN_CLIENT_GET_STATE Rückruffunktion (hwnclx.h)
Wird vom Clienttreiber implementiert, um den Zustand der Hardwarebenachrichtigungskomponente abzurufen. Sie wird aufgerufen, wenn ein Benutzer status Informationen anfordert.
Syntax
HWN_CLIENT_GET_STATE HwnClientGetState;
NTSTATUS HwnClientGetState(
[in] PVOID Context,
[out] PVOID OutputBuffer,
[in] ULONG OutputBufferLength,
[in] PVOID InputBuffer,
[in] ULONG InputBufferLength,
[out] PULONG BytesRead
)
{...}
Parameter
[in] Context
Zeiger auf die Kontextinformationen des Clienttreibers. Dieser Speicherplatz steht für die Verwendung durch den Clienttreiber zur Verfügung. Sie wird als Teil des Kontextbereichs des Frameworkobjekts von WdfDeviceCreate zugeordnet. Weitere Informationen finden Sie unter HWN_CLIENT_REGISTRATION_PACKET und Framework-Objektkontextbereich.
[out] OutputBuffer
Puffer von OutputBufferLength-Bytes zum Schreiben von Hardwarebenachrichtigungen status. Wenn die Funktion erfolgreich ist, enthält der Puffer eine HWN_HEADER-Struktur , die mindestens eine HWN_SETTINGS-Strukturen enthält.
OutputBufferLength muss groß genug sein, um alle angeforderten Einstellungen zu enthalten. Weitere Informationen finden Sie in den Hinweisen.
[in] OutputBufferLength
Die Größe von OutputBuffer in Bytes.
[in] InputBuffer
Puffer von InputBufferLength-Bytes , die einen HWN_HEADER enthalten, der eine oder mehrere HWN_SETTINGS Strukturen enthält, in denen die IDs für die angeforderten Hardwarebenachrichtigungskomponenten im Feld HwNId gespeichert werden. Dieser Puffer kann NULL sein.
[in] InputBufferLength
Die Größe von InputBuffer in Bytes.
[out] BytesRead
Zeiger auf eine Variable, die die Anzahl der von der Funktion gelesenen Bytes angibt.
Rückgabewert
Gibt STATUS_SUCCESS zurück, wenn der Vorgang erfolgreich ist. Andernfalls wird ein entsprechender NTSTATUS-Fehlercode zurückgegeben.
Hinweise
Registrieren Sie Ihre Implementierung dieser Rückruffunktion, indem Sie den entsprechenden Member von HWN_CLIENT_REGISTRATION_PACKET festlegen und dann HwNRegisterClient aufrufen.
-
Wenn InputBuffer NULL ist, wird der Ausgabepuffer zum Speichern einer HWN_HEADER-Struktur verwendet, die alle Einstellungen für die vom Treiber implementierten Hardwarebenachrichtigungen enthält.
Die Einstellungen für eine Hardwarebenachrichtigungskomponente werden in einer HWN_SETTINGS-Struktur gespeichert. Das Feld HwNSettingsInfo der HWN_HEADER-Struktur enthält ein Array von HWN_SETTINGS Strukturen.
- Wenn InputBuffer nicht NULL ist und ordnungsgemäß formatiert ist, enthält es eine HWN_HEADER mit einer oder mehreren HWN_SETTINGS Strukturen. Die IDs für die angeforderten Hardwarebenachrichtigungskomponenten werden im Feld HwNId der HWN_SETTINGS-Struktur gespeichert. Die verbleibenden Einstellungen sollten gültige Einstellungen oder null sein.
- Wenn OutputBuffer nicht groß genug ist, um alle angeforderten Einstellungen zu enthalten, sollte diese Funktion nichts in OutputBuffer schreiben. Darüber hinaus sollte BytesRead auf 0 festgelegt werden und ein Fehler zurückgegeben werden.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows 10, Version 1709 |
| Unterstützte Mindestversion (Server) | Windows Server 2016 |
| Zielplattform | Windows |
| Kopfzeile | hwnclx.h |
| IRQL | PASSIVE_LEVEL |