Función WdfIoTargetSendWriteSynchronously (wdfiotarget.h)

Artículo
03/08/2023

[Se aplica a KMDF y UMDF]

El método WdfIoTargetSendWriteSynchronously compila una solicitud de escritura y la envía de forma sincrónica a un destino de E/S.

Sintaxis

NTSTATUS WdfIoTargetSendWriteSynchronously(
  [in]            WDFIOTARGET               IoTarget,
  [in, optional]  WDFREQUEST                Request,
  [in, optional]  PWDF_MEMORY_DESCRIPTOR    InputBuffer,
  [in, optional]  PLONGLONG                 DeviceOffset,
  [in, optional]  PWDF_REQUEST_SEND_OPTIONS RequestOptions,
  [out, optional] PULONG_PTR                BytesWritten
);

Parámetros

[in] IoTarget

Identificador de un objeto de destino de E/S local o remoto obtenido de una llamada anterior a WdfDeviceGetIoTarget o WdfIoTargetCreate, o a partir de un método que proporciona un destino de E/S especializado.

[in, optional] Request

Identificador de un objeto de solicitud de marco. Este parámetro es opcional y puede ser NULL. Para obtener más información sobre este parámetro, vea la siguiente sección Comentarios.

[in, optional] InputBuffer

Puntero a una estructura de WDF_MEMORY_DESCRIPTOR asignada por el autor de la llamada que describe el búfer que contiene los datos que se escribirán en el dispositivo. Este parámetro es opcional y puede ser NULL. Para obtener más información sobre este parámetro, vea la siguiente sección Comentarios.

[in, optional] DeviceOffset

Puntero a una ubicación que especifica un desplazamiento inicial para la transferencia. El destino de E/S (es decir, el controlador inferior siguiente) define cómo usar este valor. Por ejemplo, los controladores de la pila de controladores de un disco pueden especificar un desplazamiento desde el principio del disco. El destino de E/S obtiene esta información en el miembro Parameters.Write.DeviceOffset de la estructura WDF_REQUEST_PARAMETERS de la solicitud. Este puntero es opcional. La mayoría de los controladores establecen este puntero en NULL.

[in, optional] RequestOptions

Puntero a una estructura de WDF_REQUEST_SEND_OPTIONS asignada por el autor de la llamada que especifica las opciones de la solicitud. Este puntero es opcional y puede ser NULL. Para obtener más información sobre este parámetro, vea la siguiente sección Comentarios.

[out, optional] BytesWritten

Puntero a una ubicación que recibe el número de bytes escritos, si la operación se realiza correctamente. Este puntero es opcional y puede ser NULL.

Valor devuelto

Si la operación se realiza correctamente, WdfIoTargetSendWriteSynchronousmente devuelve una vez completada la solicitud de E/S y el valor devuelto es el valor de estado de finalización de la solicitud. De lo contrario, este método podría devolver uno de los siguientes valores:

Código devuelto	Descripción
STATUS_INVALID_PARAMETER	Se ha detectado un parámetro no válido.
STATUS_INFO_LENGTH_MISMATCH	El tamaño de la estructura de WDF_REQUEST_SEND_OPTIONS al que apunta el parámetro RequestOptions era incorrecto.
STATUS_INVALID_DEVICE_REQUEST	La solicitud de E/S ya estaba en cola en un destino de E/S.
STATUS_INSUFFICIENT_RESOURCES	El marco no pudo asignar recursos del sistema (normalmente memoria).
STATUS_IO_TIMEOUT	El controlador proporcionó un valor de tiempo de espera y la solicitud no se completó dentro del tiempo asignado.
STATUS_REQUEST_NOT_ACCEPTED	El paquete de solicitud de E/S (IRP) que representa el parámetro Request no proporciona suficientes estructuras IO_STACK_LOCATION para permitir que el controlador reenvíe la solicitud.

Este método también 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

Use el método WdfIoTargetSendWriteSynchronously para enviar solicitudes de escritura de forma sincrónica. Para enviar solicitudes de escritura de forma asincrónica, use el método WdfIoTargetFormatRequestForWrite , seguido del método WdfRequestSend .

WdfIoTargetSendWriteSynchronously no devuelve hasta que se haya completado la solicitud, a menos que el controlador suministre un valor de tiempo de espera en la estructura WDF_REQUEST_SEND_OPTIONS del parámetro RequestOptions o a menos que se detecte un error.

Puede reenviar una solicitud de E/S que el controlador recibió en una cola de E/S, o bien puede crear y enviar una nueva solicitud. En cualquier caso, el marco requiere un objeto de solicitud y algún espacio de búfer.

Para reenviar una solicitud de E/S que el controlador recibió en una cola de E/S:

Especifique el identificador de la solicitud recibida para el parámetro Request del método WdfIoTargetSendWriteSynchronously.
Use el búfer de entrada de la solicitud recibida para el parámetro InputBuffer del método WdfIoTargetSendWriteSynchronously.
El controlador debe llamar a WdfRequestRetrieveInputMemory para obtener un identificador de un objeto de memoria de marco que represente el búfer de entrada de la solicitud y, a continuación, colocar ese identificador en la estructura de WDF_MEMORY_DESCRIPTOR que proporciona el controlador para el parámetro InputBuffer .

Para obtener más información sobre el reenvío de una solicitud de E/S, consulte Reenvío de solicitudes de E/S.

Los controladores suelen dividir las solicitudes de E/S recibidas en solicitudes más pequeñas que envían a un destino de E/S, por lo que el controlador puede crear nuevas solicitudes.

Para crear una nueva solicitud de E/S:

Proporcione un identificador de solicitud NULL para el parámetro Request del método WdfIoTargetSendWriteSynchronously, o cree un nuevo objeto de solicitud y proporcione su identificador:
- Si proporciona un identificador de solicitud NULL , el marco usa un objeto de solicitud interno. Esta técnica es sencilla de usar, pero el controlador no puede cancelar la solicitud.
- Si llama a WdfRequestCreate para crear uno o varios objetos de solicitud, puede reutilizar estos objetos de solicitud mediante una llamada a WdfRequestReuse. Esta técnica permite a la función de devolución de llamada EvtDriverDeviceAdd del controlador asignar previamente objetos de solicitud para un dispositivo. Además, otro subproceso de controlador puede llamar a WdfRequestCancelSentRequest para cancelar la solicitud, si es necesario.
El controlador puede especificar un parámetro RequestOptions distinto de NULL, independientemente de si el controlador proporciona un parámetro request distinto de NULL o NULL. Por ejemplo, puede usar el parámetro RequestOptions para especificar un valor de tiempo de espera.
Proporcione espacio de búfer para el parámetro InputBuffer del método WdfIoTargetSendWriteSynchronously.
El controlador puede especificar este espacio de búfer como un búfer asignado localmente, como identificador WDFMEMORY o como una lista de descriptores de memoria (MDL). Puede usar el método que sea más conveniente.

Si es necesario, el marco convierte la descripción del búfer en una que sea correcta para el método del destino de E/S para acceder a los búferes de datos.

Las técnicas siguientes para especificar el espacio de búfer están disponibles:
- Proporcione un búfer local.
  Dado que WdfIoTargetSendWriteSynchronous controla de forma sincrónica las solicitudes de E/S, el controlador puede crear búferes de solicitudes locales para la rutina de llamada, como se muestra en el ejemplo de código siguiente.
```
WDF_MEMORY_DESCRIPTOR  MemoryDescriptor;
MY_BUFFER_TYPE  MyBuffer;
WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(&MemoryDescriptor,
                                  (PVOID) &MyBuffer,
                                  sizeof(MyBuffer));
```
- Proporcione un identificador WDFMEMORY.
  Llame a WdfMemoryCreate o WdfMemoryCreatePreallocated para obtener un identificador de la memoria administrada por el marco, como se muestra en el ejemplo de código siguiente.
```
WDF_MEMORY_DESCRIPTOR  MemoryDescriptor;
WDFMEMORY  MemoryHandle = NULL;
status = WdfMemoryCreate(NULL,
                         NonPagedPool,
                         POOL_TAG,
                         MY_BUFFER_SIZE,
                         &MemoryHandle,
                         NULL);
WDF_MEMORY_DESCRIPTOR_INIT_HANDLE(&MemoryDescriptor,
                                  MemoryHandle,
                                  NULL);
```
  Como alternativa, el controlador puede llamar a WdfRequestRetrieveInputMemory para obtener un identificador de un objeto de memoria de marco que representa el búfer de entrada de una solicitud de E/S recibida, si desea que el controlador pase el contenido de ese búfer al destino de E/S. El controlador no debe completar la solicitud de E/S recibida hasta que la nueva solicitud que WdfIoTargetSendWriteSynchronousmente envía al destino de E/S se ha eliminado, reutilizado o vuelto a formatear. (WdfIoTargetSendWriteSynchronousmente incrementa el recuento de referencias del objeto de memoria. Al eliminar, reutilizar o volver a formatear un objeto de solicitud, se reduce el recuento de referencias del objeto de memoria).
- Proporcione una MDL.
  Los controladores pueden obtener la MDL asociada a una solicitud de E/S recibida llamando a WdfRequestRetrieveInputWdmMdl.

Algunos destinos de E/S aceptan solicitudes de escritura que tienen un búfer de longitud cero. Para estos destinos de E/S, el controlador puede especificar NULL para el parámetro InputBuffer .

Para obtener información sobre cómo obtener información de estado una vez completada una solicitud de E/S, vea Obtener información de finalización.

Para obtener más información sobre WdfIoTargetSendWriteSynchronously, consulte Envío de solicitudes de E /S a destinos de E/S generales.

Para obtener más información sobre los destinos de E/S, consulte Uso de destinos de E/S.

Ejemplos

En el ejemplo de código siguiente se crea un objeto de memoria de marco, se inicializa una estructura de WDF_MEMORY_DESCRIPTOR y se pasa la estructura a WdfIoTargetSendWriteSynchronously. En este ejemplo se especifica NULL para el identificador de objeto de solicitud, por lo que el marco creará un nuevo objeto de solicitud para el destino de E/S.

WDF_MEMORY_DESCRIPTOR  MemoryDescriptor;
WDFMEMORY  MemoryHandle = NULL;
ULONG_PTR  bytesWritten = NULL;

status = WdfMemoryCreate(
                         NULL,
                         NonPagedPool,
                         POOL_TAG,
                         MY_BUFFER_SIZE,
                         &MemoryHandle,
                         NULL
                         );
WDF_MEMORY_DESCRIPTOR_INIT_HANDLE(
                                  &MemoryDescriptor,
                                  MemoryHandle,
                                  NULL
                                  );
status = WdfIoTargetSendWriteSynchronously(
                                          ioTarget,
                                          NULL,
                                          &MemoryDescriptor,
                                          NULL,
                                          NULL,
                                          &bytesWritten
                                          );

Requisitos

Requisito	Value
Plataforma de destino	Universal
Versión mínima de KMDF	1.0
Versión mínima de UMDF	2.0
Encabezado	wdfiotarget.h (incluya Wdf.h)
Library	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	<=PASSIVE_LEVEL
Reglas de cumplimiento de DDI	DeferredRequestCompleted(kmdf), DriverCreate(kmdf), InternalIoctlReqs(kmdf), IoctlReqs(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), ReadReqs(kmdf), RequestCompleted(kmdf), RequestCompletedLocal(kmdf), SyncReqSend(kmdf)