SerCxRetrieveTransmitBuffer-Funktion (sercx.h)
Die SerCxRetrieveTransmitBuffer Methode ruft einen Ausgabepuffer ab, der Daten enthält, die an den seriellen Port übertragen werden können.
Syntax
NTSTATUS SerCxRetrieveTransmitBuffer(
[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 SerCxRetrieveTransmitBuffer Aufruf erfolgreich ausgeführt wird, empfängt der Aufrufer einen Ausgabepuffer, der bis zu Länge Byte verfügbarer Daten enthält. (Die verfügbaren Daten im Puffer sind möglicherweise kleiner als Länge Bytes.) SerCxRetrieveTransmitBuffer schreibt die tatsächliche Anzahl der Bytes verfügbarer Daten 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 Übertragungsvorgang 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
SerCxRetrieveTransmitBuffer 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 Übertragungspuffer. |
|
Die falsche Größe wird für die SERCX_BUFFER_DESCRIPTOR Struktur angegeben. |
|
Systemressourcen konnten nicht zugeordnet werden (in der Regel Arbeitsspeicher). |
Bemerkungen
Der serielle Controllertreiber ruft diese Methode auf, um einen Puffer abzurufen, der die Ausgabedaten für den aktuellen Sendevorgang (Schreibvorgang) enthält.
Anforderungen
Anforderung | Wert |
---|---|
mindestens unterstützte Client- | Verfügbar ab Windows 8. |
Zielplattform- | Universal |
Header- | sercx.h |
IRQL- | <= DISPATCH_LEVEL |