SerCxRetrieveReceiveBuffer-Funktion (sercx.h)
Die SerCxRetrieveReceiveBuffer Methode ruft einen Eingabepuffer ab, in den die vom seriellen Port empfangenen Daten geladen werden können.
Syntax
NTSTATUS SerCxRetrieveReceiveBuffer(
[in] WDFDEVICE Device,
[in] ULONG Length,
[in, out] PSERCX_BUFFER_DESCRIPTOR BufferDescriptor
);
Parameter
[in] Device
Ein WDFDEVICE-Handle für das Framework-Geräteobjekt, das den seriellen Controller darstellt.
[in] Length
Die angeforderte Pufferlänge in Byte. Wenn der SerCxRetrieveReceiveBuffer Aufruf erfolgreich ist, empfängt der Aufrufer einen Eingabepuffer, der bis zu Länge Bytes verfügbaren Speicherplatz enthält. (Der verfügbare Speicherplatz im Puffer ist möglicherweise kleiner als Länge Bytes.) SerCxRetrieveReceiveBuffer schreibt die tatsächliche Anzahl der Bytes des verfügbaren Speicherplatzes in das Length Member der Struktur, auf das der BufferDescriptor Parameter verweist.
[in, out] BufferDescriptor
Ein Zeiger auf eine vom Aufrufer zugewiesene SERCX_BUFFER_DESCRIPTOR Struktur. Diese Struktur beschreibt den Datenpuffer, der für den Empfangsvorgang verwendet werden soll. Der Aufrufer hat zuvor die SERCX_BUFFER_DESCRIPTOR_INIT-Funktion aufgerufen, um diese Struktur zu initialisieren. SerCxRetrieveTransmitBuffer schreibt in die Buffer und Length Member dieser Struktur.
Rückgabewert
SerCxRetrieveReceiveBuffer gibt STATUS_SUCCESS zurück, wenn dies erfolgreich ist. Mögliche Fehlerrückgabewerte sind die folgenden Statuscodes.
Rückgabecode | Beschreibung |
---|---|
|
Die Methode wurde beim falschen IRQL aufgerufen; oder der WDFDEVICE-Handle ist ungültig; oder Device oder BufferDescriptor null ist; oder der Treiber verfügt bereits über einen Empfangspuffer. |
|
Die falsche Größe wird für die SERCX_BUFFER_DESCRIPTOR Struktur angegeben. |
|
Systemressourcen konnten nicht zugeordnet werden (in der Regel Arbeitsspeicher). |
Bemerkungen
Der Treiber des seriellen Controllers ruft diese Methode auf, um einen Puffer abzurufen, der Eingabedaten aus dem aktuellen Empfangsvorgang (Lesevorgang) enthält.
Anforderungen
Anforderung | Wert |
---|---|
mindestens unterstützte Client- | Verfügbar ab Windows 8. |
Zielplattform- | Universal |
Header- | sercx.h |
IRQL- | <= DISPATCH_LEVEL |