IWDFIoRequest2::RetrieveOutputMemory-Methode (wudfddi.h)
[Warnung: UMDF 2 ist die neueste Version von UMDF und ersetzt UMDF 1. Alle neuen UMDF-Treiber sollten mit UMDF 2 geschrieben werden. Es werden keine neuen Features zu UMDF 1 hinzugefügt, und es gibt eingeschränkte Unterstützung für UMDF 1 für neuere Versionen von Windows 10. Universelle Windows-Treiber müssen UMDF 2 verwenden. Weitere Informationen finden Sie unter Erste Schritte mit UMDF-.]
Die RetrieveOutputMemory-methode ruft die IWDFMemory Schnittstelle eines Framework-Speicherobjekts ab, das den Ausgabepuffer einer E/A-Anforderung darstellt.
Syntax
HRESULT RetrieveOutputMemory(
[out] IWDFMemory **Memory
);
Parameter
[out] Memory
Die Adresse eines Speicherorts, der einen Zeiger auf das IWDFMemory Schnittstelle eines UMDF-Speicherobjekts empfängt.
Rückgabewert
RetrieveOutputMemory- gibt S_OK zurück, wenn der Vorgang erfolgreich ist. Andernfalls kann diese Methode den folgenden Wert zurückgeben:
| Rückgabecode | Beschreibung |
|---|---|
|
Die E/A-Anforderung hat keinen Eingabepuffer bereitgestellt. |
|
Nicht genügend Arbeitsspeicher zum Abrufen des Puffers verfügbar. Der Treiber sollte die Anforderung mit einem Fehlerstatuswert abschließen. |
Diese Methode gibt möglicherweise einen der anderen Werte zurück, die Winerror.h enthält.
Bemerkungen
Der Ausgabepuffer einer Anforderung empfängt Informationen, z. B. Daten von einem Datenträger, die der Treiber dem Absender der Anforderung bereitstellt. Ihr Treiber kann RetrieveOutputMemory- aufrufen, um den Ausgabepuffer für eine Leseanforderung oder eine Geräte-E/A-Steuerelementanforderung abzurufen, aber nicht für eine Schreibanforderung (da Schreibanforderungen keine Ausgabedaten bereitstellen).
Die RetrieveOutputMemory Methode ruft den Ausgabepuffer für E/A-Anforderungen ab, die die gepufferten E/A- oder direkten E/A--Methode für den Zugriff auf Datenpuffer verwenden.
Wenn RetrieveOutputMemory S_OK zurückgibt, empfängt der Treiber einen Zeiger auf die IWDFMemory Schnittstelle eines UMDF-Speicherobjekts, das den Ausgabepuffer darstellt. Um auf den Puffer zuzugreifen, muss der Treiber IWDFMemory::GetDataBufferaufrufen.
Der Treiber kann auf das abgerufene Framework-Speicherobjekt zugreifen, bis es der E/A-Anforderung abgeschlossen ist. Bevor der Treiber die E/A-Anforderung abgeschlossen hat, muss er IWDFMemory::Releaseaufrufen.
Anstatt RetrieveOutputMemory-aufzurufen, kann der Treiber IWDFIoRequest2::RetrieveOutputBufferaufrufen, wodurch die Adresse und Länge des Puffers abgerufen wird.
Weitere Informationen zum Zugreifen auf die Datenpuffer einer E/A-Anforderung finden Sie unter Zugreifen auf Datenpuffer in UMDF-Based Drivers.
Beispiele
Das folgende Codebeispiel zeigt, wie eine IQueueCallbackRead::OnRead- Rückruffunktion die IWDFMemory Schnittstelle des Framework-Speicherobjekts abrufen kann, das den Ausgabepuffer einer Leseanforderung darstellt. Anschließend wird die Leseanforderung an ein USB-E/A-Ziel formatiert und gesendet.
VOID
STDMETHODCALLTYPE
CMyQueue::OnRead(
__in IWDFIoQueue *pWdfQueue,
__in IWDFIoRequest *pWdfRequest,
__in SIZE_T BytesToRead
)
{
HRESULT hr = S_OK;
IWDFMemory * pOutputMemory = NULL;
//
// Declare an IWDFIoRequest2 interface pointer and obtain the
// IWDFIoRequest2 interface from the IWDFIoRequest interface.
//
CComQIPtr<IWDFIoRequest2> r2 = pWdfRequest;
r2->RetrieveOutputMemory(&pOutputMemory);
if (FAILED(hr)) goto Exit;
hr = m_Device->GetInputPipe()->FormatRequestForRead(pWdfRequest,
NULL,
pOutputMemory,
NULL,
NULL);
Exit:
if (FAILED(hr))
{
pWdfRequest->Complete(hr);
}
else
{
ForwardFormattedRequest(pWdfRequest, m_Device->GetInputPipe());
}
SAFE_RELEASE(pOutputMemory);
return;
}
Anforderungen
| Anforderung | Wert |
|---|---|
| Ende des Supports | In UMDF 2.0 und höher nicht verfügbar. |
| Zielplattform- | Desktop |
| Mindest-UMDF-Version | 1.9 |
| Header- | wudfddi.h (include Wudfddi.h) |
| DLL- | WUDFx.dll |
Siehe auch
IWDFIoRequest2::RetrieveInputBuffer
IWDFIoRequest2::RetrieveInputMemory