Função WdfDeviceRetrieveDeviceName (wdfdevice.h)

  • Artigo

[Aplica-se somente ao KMDF]

O método WdfDeviceRetrieveDeviceName retorna o nome do dispositivo para um dispositivo especificado.

Sintaxe

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

Parâmetros

[in] Device

Um identificador para um objeto de dispositivo de estrutura.

[in] String

Um identificador para um objeto de cadeia de caracteres de estrutura que recebe o nome do dispositivo.

Retornar valor

Se a operação for bem-sucedida, WdfDeviceRetrieveDeviceName retornará STATUS_SUCCESS. Os valores retornados adicionais incluem:

Código de retorno Descrição
STATUS_INVALID_PARAMETER
 Um parâmetro inválido foi detectado.
 

O método pode retornar outros valores NTSTATUS.

Um bug marcar ocorrerá se o driver fornecer um identificador de objeto inválido.

Comentários

O método WdfDeviceRetrieveDeviceName retorna o nome do dispositivo especificado pelo driver em uma chamada anterior para WdfDeviceInitAssignName.

Para obter a cadeia de caracteres de nome do dispositivo do objeto de cadeia de caracteres, o driver pode chamar WdfStringGetUnicodeString.

Exemplos

O exemplo de código a seguir cria um objeto de cadeia de caracteres e recupera o nome de um 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 Valor
Plataforma de Destino Universal
Versão mínima do KMDF 1.0
Cabeçalho wdfdevice.h (inclua Wdf.h)
Biblioteca Wdf01000.sys (consulte Controle de versão da biblioteca de estrutura.)
IRQL PASSIVE_LEVEL
Regras de conformidade de DDI DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Confira também

WdfDeviceInitAssignName

WdfDeviceQueryProperty

WdfStringCreate