WdfDriverRetrieveVersionString-Funktion (wdfdriver.h)

Artikel
02/29/2024

[Gilt für KMDF und UMDF]

Die WdfDriverRetrieveVersionString-Methode ruft eine Unicode-Zeichenfolge ab, die die Version des Kernel-Mode Driver Framework identifiziert, mit dem der Treiber ausgeführt wird.

Syntax

NTSTATUS WdfDriverRetrieveVersionString(
  [in] WDFDRIVER Driver,
  [in] WDFSTRING String
);

Parameter

[in] Driver

Ein Handle für das Frameworktreiberobjekt des Treibers, das der Treiber von einem vorherigen Aufruf von WdfDriverCreate oder WdfGetDriver abgerufen hat.

[in] String

Ein Handle für ein Frameworkzeichenfolgenobjekt, das der Treiber aus einem vorherigen Aufruf von WdfStringCreate abgerufen hat. Das Framework weist die Versionszeichenfolge dem Zeichenfolgenobjekt zu.

Rückgabewert

WdfDriverRetrieveVersionString gibt STATUS_SUCCESS zurück, wenn der Vorgang erfolgreich ist. Andernfalls gibt diese Methode möglicherweise einen der folgenden Werte zurück:

Rückgabecode	Beschreibung
STATUS_INSUFFICIENT_RESOURCES	Das Framework konnte keinen Puffer für die Unicode-Zeichenfolge zuordnen.

Diese Methode kann auch andere NTSTATUS-Werte zurückgeben.

Wenn das Treiberhandle ungültig ist, wird eine Systemfehlerprüfung durchgeführt.

Hinweise

Ihr Treiber kann WdfDriverRetrieveVersionString aufrufen, wenn Sie eine Zeichenfolge anzeigen möchten, die die Version der Frameworkbibliothek identifiziert. Das Format der Zeichenfolge kann sich von einer Version in eine andere ändern, sodass der Treiber nicht versuchen darf, das Format oder den Inhalt der Zeichenfolge zu interpretieren.

Weitere Informationen zu Bibliotheksversionen finden Sie unter Versionierung der Frameworkbibliothek.

Beispiele

Im folgenden Codebeispiel wird ein Zeichenfolgenobjekt erstellt, dem Objekt die Versionszeichenfolge zugewiesen und die Zeichenfolge angezeigt, wenn ein Debugger ausgeführt wird.

WDFSTRING string;
UNICODE_STRING us;

status = WdfStringCreate(
                         NULL,
                         WDF_NO_OBJECT_ATTRIBUTES,
                         &string
                         );
if (NT_SUCCESS(status)) {
    status = WdfDriverRetrieveVersionString(
                                            driver,
                                            string
                                            );
    if (NT_SUCCESS(status)) {
        WdfStringGetUnicodeString(
                                  string,
                                  &us
                                  );
        DbgPrint(
                 "WDF Version string:  %wZ\n",
                 &us
                 );
    }
    WdfObjectDelete(string);
}

Anforderungen

Anforderung	Wert
Zielplattform	Universell
KMDF-Mindestversion	1.0
UMDF-Mindestversion	2.0
Kopfzeile	wdfdriver.h (einschließen von Wdf.h)
Bibliothek	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
DDI-Complianceregeln	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)