IWDFIoRequest2 ::RetrieveOutputBuffer, méthode (wudfddi.h)

Article
02/07/2025

[Avertissement : UMDF 2 est la dernière version de UMDF et remplace UMDF 1. Tous les nouveaux pilotes UMDF doivent être écrits à l’aide de UMDF 2. Aucune nouvelle fonctionnalité n’est ajoutée à UMDF 1 et il existe une prise en charge limitée de UMDF 1 sur les versions plus récentes de Windows 10. Les pilotes Windows universels doivent utiliser UMDF 2. Pour plus d’informations, consultez Bien démarrer avec UMDF.]

La méthode RequestRetrieveOutputBuffer récupère la mémoire tampon de sortie d’une requête d’E/S.

Syntaxe

HRESULT RetrieveOutputBuffer(
  [in]            SIZE_T MinimumRequiredCb,
  [out]           PVOID  *Buffer,
  [out, optional] SIZE_T *BufferCb
);

Paramètres

[in] MinimumRequiredCb

Taille minimale de la mémoire tampon, en octets, que le pilote doit traiter la requête d’E/S. Cette valeur peut être égale à zéro s’il n’y a pas de taille de mémoire tampon minimale.

[out] Buffer

Pointeur vers un emplacement qui reçoit l’adresse de la mémoire tampon.

[out, optional] BufferCb

Pointeur vers un emplacement qui reçoit la taille de la mémoire tampon, en octets. Ce paramètre est facultatif et peut être NULL.

Valeur de retour

RequestRetrieveOutputBuffer retourne S_OK si l’opération réussit. Sinon, cette méthode peut retourner la valeur suivante :

Retourner le code	Description
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	La demande d’E/S n’a pas fourni de mémoire tampon de sortie, ou la taille de la mémoire tampon de sortie est inférieure à la taille minimale spécifiée par MinimumRequiredCb.
E_OUTOFMEMORY	La mémoire insuffisante est disponible pour récupérer la mémoire tampon. Le pilote doit terminer la demande avec une valeur d’état d’erreur.

Cette méthode peut retourner l’une des autres valeurs que Winerror.h contient.

Remarques

La mémoire tampon de sortie d’une requête reçoit des informations, telles que les données d’un disque, que le pilote fournit à l’origine de la requête. Votre pilote peut appeler RequestRetrieveOutputBuffer pour obtenir la mémoire tampon de sortie d’une demande de lecture ou d’une demande de contrôle d’E/S d’appareil, mais pas pour une demande d’écriture (car les demandes d’écriture ne fournissent pas de données de sortie).

La méthode RequestRetrieveOutputBuffer récupère la mémoire tampon de sortie pour les requêtes d’E/S qui utilisent les d’E/S mises en mémoire tampon ou méthode d' E/S directes pour accéder aux mémoires tampons de données.

Si RequestRetrieveOutputBuffer retourne S_OK, le pilote reçoit l’adresse et, éventuellement, la taille de la mémoire tampon de sortie.

Le pilote peut accéder à la mémoire tampon récupérée jusqu’à ce qu’elle termine la requête d’E/S.

Au lieu d’appeler RequestRetrieveOutputBuffer, le pilote peut appeler IWDFIoRequest2 ::RetrieveOutputMemory, ce qui crée un objet mémoire framework qui représente la mémoire tampon.

Pour plus d’informations sur l’accès aux mémoires tampons de données d’une requête d’E/S, consultez Accès aux mémoires tampons de données dans UMDF-Based Pilotes.

Exemples

L’exemple de code suivant montre un segment du pilote de port série IQueueCallbackDeviceIoControl ::OnDeviceIoControl fonction de rappel. Le segment de code obtient la mémoire tampon de sortie de la requête d’E/S, puis transfère les informations de débit baud de l’appareil à la mémoire tampon.

VOID
STDMETHODCALLTYPE
  CMyQueue::OnDeviceIoControl(
    __in IWDFIoQueue *pWdfQueue,
    __in IWDFIoRequest *pWdfRequest,
    __in ULONG ControlCode,
    __in SIZE_T InputBufferSizeInBytes,
    __in SIZE_T OutputBufferSizeInBytes
    )
{
    HRESULT hr;
    //
    // Declare an IWDFIoRequest2 interface pointer and obtain the
    // IWDFIoRequest2 interface from the IWDFIoRequest interface.
    //
    CComQIPtr<IWDFIoRequest2> r2 = pWdfRequest;

    switch (ControlCode)
    {
        case IOCTL_SERIAL_GET_BAUD_RATE:
        {
            SERIAL_BAUD_RATE *pBaudRateBuffer;
            hr = pWdfRequest2->RetrieveOutputBuffer(sizeof(SERIAL_BAUD_RATE),
                                                    (PVOID*) &pBaudRateBuffer,
                                                    NULL);
            if (SUCCEEDED(hr))
                  {
                      RtlZeroMemory(pBaudRateBuffer, sizeof(SERIAL_BAUD_RATE));
                      pBaudRateBuffer->BaudRate = m_Device->GetBaudRate();
                      reqCompletionInfo = sizeof(SERIAL_BAUD_RATE);
                  }
            
        }
        break;
        ...
    }
    ...
}

Exigences

Exigence	Valeur
fin du support	Indisponible dans UMDF 2.0 et versions ultérieures.
plateforme cible	Bureau
version minimale de UMDF	1.9
d’en-tête	wudfddi.h (include Wudfddi.h)
DLL	WUDFx.dll