Función WdfDeviceRetrieveDeviceName (wdfdevice.h)

  • Artículo

[Solo se aplica a KMDF]

El método WdfDeviceRetrieveDeviceName devuelve el nombre del dispositivo para un dispositivo especificado.

Sintaxis

NTSTATUS WdfDeviceRetrieveDeviceName(
  [in] WDFDEVICE Device,
  [in] WDFSTRING String
);

Parámetros

[in] Device

Identificador de un objeto de dispositivo de marco.

[in] String

Identificador de un objeto de cadena de marco que recibe el nombre del dispositivo.

Valor devuelto

Si la operación se realiza correctamente, WdfDeviceRetrieveDeviceName devuelve STATUS_SUCCESS. Entre los valores devueltos adicionales se incluyen:

Código devuelto Descripción
STATUS_INVALID_PARAMETER
 Se ha detectado un parámetro no válido.
 

El método podría devolver otros valores NTSTATUS.

Se produce una comprobación de errores si el controlador proporciona un identificador de objeto no válido.

Comentarios

El método WdfDeviceRetrieveDeviceName devuelve el nombre del dispositivo que el controlador especificó en una llamada anterior a WdfDeviceInitAssignName.

Para obtener la cadena de nombre de dispositivo del objeto de cadena, el controlador puede llamar a WdfStringGetUnicodeString.

Ejemplos

En el ejemplo de código siguiente se crea un objeto de cadena y, a continuación, se recupera el nombre de un dispositivo especificado.

NTSTATUS status;
WDFSTRING string;

status = WdfStringCreate(
                         NULL,
                         WDF_NO_OBJECT_ATTRIBUTES,
                         &string
                         );
if (NT_SUCCESS(status)) {
    status = WdfDeviceRetrieveDeviceName(
                                         Device,
                                         string
                                         );
    if (!NT_SUCCESS(status)) {
        return status;
    }
}

Requisitos

Requisito Value
Plataforma de destino Universal
Versión mínima de KMDF 1.0
Encabezado wdfdevice.h (incluya Wdf.h)
Library Wdf01000.sys (consulte Control de versiones de la biblioteca de marcos).
IRQL PASSIVE_LEVEL
Reglas de cumplimiento de DDI DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Consulte también

WdfDeviceInitAssignName

WdfDeviceQueryProperty

WdfStringCreate