Función WdfDriverRetrieveVersionString (wdfdriver.h)

Artículo
02/27/2024

[Se aplica a KMDF y UMDF]

El método WdfDriverRetrieveVersionString recupera una cadena Unicode que identifica la versión de Kernel-Mode Driver Framework con la que se ejecuta el controlador.

Sintaxis

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

Parámetros

[in] Driver

Identificador del objeto de controlador del marco de trabajo del controlador que obtuvo el controlador de una llamada anterior a WdfDriverCreate o WdfGetDriver.

[in] String

Identificador de un objeto de cadena de marco que el controlador obtuvo de una llamada anterior a WdfStringCreate. El marco asigna la cadena de versión al objeto de cadena.

Valor devuelto

WdfDriverRetrieveVersionString devuelve STATUS_SUCCESS si la operación se realiza correctamente. De lo contrario, este método podría devolver uno de los siguientes valores:

Código devuelto	Descripción
STATUS_INSUFFICIENT_RESOURCES	El marco no pudo asignar un búfer para la cadena Unicode.

Este método también podría devolver otros valores NTSTATUS.

Se produce una comprobación de errores del sistema si el controlador no es válido.

Comentarios

El controlador puede llamar a WdfDriverRetrieveVersionString si desea mostrar una cadena que identifique la versión de la biblioteca de marcos. El formato de la cadena puede cambiar de una versión a otra, por lo que el controlador no debe intentar interpretar el formato o el contenido de la cadena.

Para obtener más información sobre las versiones de la biblioteca, consulte Control de versiones de la biblioteca de marcos.

Ejemplos

En el ejemplo de código siguiente se crea un objeto de cadena, se asigna la cadena de versión al objeto y se muestra la cadena si se está ejecutando un depurador.

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

Requisitos

Requisito	Value
Plataforma de destino	Universal
Versión mínima de KMDF	1.0
Versión mínima de UMDF	2.0
Encabezado	wdfdriver.h (incluir Wdf.h)
Library	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
Reglas de cumplimiento de DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)