Función WdfChildListRetrieveAddressDescription (wdfchildlist.h)

  • Artículo

[Solo se aplica a KMDF]

El método WdfChildListRetrieveAddressDescription busca un dispositivo secundario que tiene una descripción de identificación especificada y recupera la descripción de la dirección del dispositivo.

Sintaxis

NTSTATUS WdfChildListRetrieveAddressDescription(
  [in]      WDFCHILDLIST                                 ChildList,
  [in]      PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription,
  [in, out] PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER        AddressDescription
);

Parámetros

[in] ChildList

Identificador de un objeto de lista secundario.

[in] IdentificationDescription

Puntero a una estructura de WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER asignada por el autor de la llamada que identifica una descripción de identificación secundaria proporcionada por el controlador.

[in, out] AddressDescription

Puntero a una estructura WDF_CHILD_ADDRESS_DESCRIPTION_HEADER que identifica una descripción de dirección secundaria. El marco rellena esta descripción.

Valor devuelto

WdfChildListRetrieveAddressDescription devuelve STATUS_SUCCESS u otro valor de estado para el que NT_SUCCESS(status) es igual a TRUE, 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_INVALID_PARAMETER
 Un parámetro de entrada no era válido.
STATUS_NO_SUCH_DEVICE
 Ningún dispositivo coincide con la descripción de identificación especificada.
STATUS_INVALID_DEVICE_REQUEST
 La lista secundaria no contenía descripciones de direcciones o el tamaño de la descripción de la dirección especificada por AddressDescription era incorrecta.
 

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

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

Comentarios

Para obtener más información sobre las listas secundarias, vea Enumeración dinámica.

Ejemplos

En el ejemplo de código siguiente se busca una lista secundaria de un dispositivo secundario cuya descripción de identificación contiene el valor especificado por SomeValue. Si WdfChildListRetrieveAddressDescription busca el dispositivo, recupera la descripción de la dirección del dispositivo.

MY_IDENTIFICATION_DESCRIPTION  id;
MY_ADDRESS_DESCRIPTION  addrDescrip;

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(
                                                 &id.Header,
                                                 sizeof(id)
                                                 );
WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT(
                                          &addrDescrip.Header,
                                          sizeof(addrDescrip)
                                          );

id.DeviceIdentifier = SomeValue;
status = WdfChildListRetrieveAddressDescription(
                                                list,
                                                &idDescrip.Header,
                                                &addrDescrip.Header
                                                );
if (!NT_SUCCESS(status) {
    return status;
}

Requisitos

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

Consulte también

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT