Funzione WdfDriverRetrieveVersionString (wdfdriver.h)

Articolo
02/29/2024

[Si applica a KMDF e UMDF]

Il metodo WdfDriverRetrieveVersionString recupera una stringa Unicode che identifica la versione del framework driver di Kernel-Mode con cui è in esecuzione il driver.

Sintassi

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

Parametri

[in] Driver

Handle all'oggetto driver del framework del driver ottenuto da una chiamata precedente a WdfDriverCreate o WdfGetDriver.

[in] String

Handle per un oggetto stringa del framework ottenuto dal driver da una chiamata precedente a WdfStringCreate. Il framework assegna la stringa di versione all'oggetto string.

Valore restituito

WdfDriverRetrieveVersionString restituisce STATUS_SUCCESS se l'operazione ha esito positivo. In caso contrario, questo metodo potrebbe restituire uno dei valori seguenti:

Codice restituito	Descrizione
STATUS_INSUFFICIENT_RESOURCES	Il framework non è riuscito a allocare un buffer per la stringa Unicode.

Questo metodo potrebbe restituire anche altri valori NTSTATUS.

Un controllo del bug di sistema si verifica se l'handle driver non è valido.

Commenti

Il driver può chiamare WdfDriverRetrieveVersionString se si vuole visualizzare una stringa che identifica la versione della libreria framework. Il formato della stringa potrebbe cambiare da una versione a un'altra, quindi il driver non deve tentare di interpretare il formato o il contenuto della stringa.

Per altre informazioni sulle versioni della libreria, vedere Controllo delle versioni della libreria Framework.

Esempio

Nell'esempio di codice seguente viene creato un oggetto stringa, viene assegnata la stringa di versione all'oggetto e viene visualizzata la stringa se è in esecuzione un debugger.

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);
}

Requisiti

Requisito	Valore
Piattaforma di destinazione	Universale
Versione KMDF minima	1.0
Versione UMDF minima	2,0
Intestazione	wdfdriver.h (includere Wdf.h)
Libreria	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
Regole di conformità DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)