Função WdfRequestRetrieveInputBuffer (wdfrequest.h)
[Aplica-se a KMDF e UMDF]
O método WdfRequestRetrieveInputBuffer recupera o buffer de entrada de uma solicitação de E/S.
Sintaxe
NTSTATUS WdfRequestRetrieveInputBuffer(
[in] WDFREQUEST Request,
size_t MinimumRequiredLength,
[out] PVOID *Buffer,
[out, optional] size_t *Length
);
Parâmetros
[in] Request
Um identificador para um objeto de solicitação de estrutura.
MinimumRequiredLength
O tamanho mínimo do buffer, em bytes, que o driver precisa para processar a solicitação de E/S.
[out] Buffer
Um ponteiro para um local que recebe o endereço do buffer.
[out, optional] Length
Um ponteiro para um local que recebe o tamanho do buffer, em bytes. Esse parâmetro é opcional e pode ser NULL.
Retornar valor
WdfRequestRetrieveInputBuffer retornará STATUS_SUCCESS se a operação for bem-sucedida. Caso contrário, esse método poderá retornar um dos seguintes valores:
Código de retorno | Descrição |
---|---|
|
Um parâmetro de entrada é inválido. |
|
O comprimento do buffer de entrada é zero ou o parâmetro MinimumRequiredSize especifica um tamanho de buffer maior que o tamanho real do buffer. |
|
O tipo de solicitação não é válido ou a solicitação não está usando e/S direta nem buffer. Para obter mais informações sobre métodos com suporte para acessar buffers de dados, consulte a seção Comentários a seguir. |
|
A solicitação já foi concluída. |
|
Não há memória suficiente. |
Esse método também pode retornar outros valores NTSTATUS.
Um bug marcar ocorrerá se o driver fornecer um identificador de objeto inválido.
Comentários
O buffer de entrada de uma solicitação contém informações, como dados a serem gravados em um disco, que foram fornecidos pelo originador da solicitação. Seu driver pode chamar WdfRequestRetrieveInputBuffer para obter o buffer de entrada para uma solicitação de gravação ou uma solicitação de controle de E/S do dispositivo, mas não para uma solicitação de leitura (porque as solicitações de leitura não fornecem dados de entrada).
O método WdfRequestRetrieveInputBuffer recupera o buffer de entrada para solicitações de E/S que usam o método de E/S armazenado em buffer ou o método de E/S direto para acessar buffers de dados. Se o código de controle de E/S da solicitação for IRP_MJ_INTERNAL_DEVICE_CONTROL ou se a solicitação veio de outro driver no modo kernel, WdfRequestRetrieveInputBuffer também oferecerá suporte a solicitações de E/S que não usam E /S nem buffer.
Se WdfRequestRetrieveInputBuffer retornar STATUS_SUCCESS, o driver receberá o endereço e, opcionalmente, o tamanho do buffer de entrada.
O driver pode acessar o buffer recuperado até concluir a solicitação de E/S que o parâmetro Request representa.
Em vez de chamar WdfRequestRetrieveInputBuffer, o driver pode chamar WdfRequestRetrieveInputMemory, que cria um objeto de memória de estrutura que representa o buffer.
Para obter mais informações sobre WdfRequestRetrieveInputBuffer, consulte Acessando buffers de dados em drivers de Framework-Based.
Exemplos
O exemplo de código a seguir faz parte da função de retorno de chamada EvtIoDeviceControl do driver de exemplo serial. Se o código de controle de E/S for IOCTL_SERIAL_SET_TIMEOUT, o driver obterá novos valores de tempo limite do buffer de entrada da solicitação de E/S.
VOID
SerialEvtIoDeviceControl(
IN WDFQUEUE Queue,
IN WDFREQUEST Request,
IN size_t OutputBufferLength,
IN size_t InputBufferLength,
IN ULONG IoControlCode
)
{
PVOID buffer;
size_t bufSize;
switch (IoControlCode) {
...
case IOCTL_SERIAL_SET_TIMEOUTS: {
PSERIAL_TIMEOUTS NewTimeouts;
Status = WdfRequestRetrieveInputBuffer(
Request,
sizeof(SERIAL_TIMEOUTS),
&buffer,
&bufSize
);
if (!NT_SUCCESS(Status)) {
break;
}
NewTimeouts =(PSERIAL_TIMEOUTS)buffer;
}
...
}
Requisitos
Requisito | Valor |
---|---|
Plataforma de Destino | Universal |
Versão mínima do KMDF | 1.0 |
Versão mínima do UMDF | 2,0 |
Cabeçalho | wdfrequest.h (inclua Wdf.h) |
Biblioteca | Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF) |
IRQL | <=DISPATCH_LEVEL |
Regras de conformidade de DDI | BufAfterReqCompletedIntIoctl(kmdf), BufAfterReqCompletedIntIoctlA(kmdf), BufAfterReqCompletedIoctl(kmdf), BufAfterReqCompletedIoctlA(kmdf), BufAfterReqCompletedRead(kmdf), BufAfterReqCompletedWrite(kmdf), BufAfterReqCompletedWriteA(kmdf), DriverCreate(kmdf), InputBufferAPI(kmdf), InvalidReqAccess(kmdf), InvalidReqAccessLocal(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |