EDITSTREAMCALLBACK-Rückruffunktion (richedit.h)
Die EditStreamCallback--Funktion ist eine anwendungsdefinierte Rückruffunktion, die mit den nachrichten EM_STREAMIN und EM_STREAMOUT verwendet wird. Es wird verwendet, um einen Datenstrom in ein oder aus einem Rich-Edit-Steuerelement zu übertragen. Der EDITSTREAMCALLBACK- Typ definiert einen Zeiger auf diese Rückruffunktion. EditStreamCallback- ist ein Platzhalter für den anwendungsdefinierte Funktionsnamen.
Syntax
EDITSTREAMCALLBACK Editstreamcallback;
DWORD Editstreamcallback(
[in] DWORD_PTR dwCookie,
[in] LPBYTE pbBuff,
[in] LONG cb,
[in] LONG *pcb
)
{...}
Parameter
[in] dwCookie
Typ: DWORD_PTR
Wert des dwCookie Member der EDITSTREAM Struktur. Die Anwendung gibt diesen Wert an, wenn der EM_STREAMIN oder EM_STREAMOUT Nachricht gesendet wird.
[in] pbBuff
Typ: LPBYTE-
Zeiger auf einen Puffer, aus dem gelesen oder geschrieben werden soll. Bei einem Stream-In-Vorgang (Lesevorgang) füllt die Rückruffunktion diesen Puffer mit Daten aus, die in das Rich-Edit-Steuerelement übertragen werden. Bei einem Streamout-Vorgang (Schreiben) enthält der Puffer Daten aus dem Steuerelement, das die Rückruffunktion in einen bestimmten Speicher schreibt.
[in] cb
Typ: LONG
Anzahl der Bytes, die gelesen oder geschrieben werden sollen.
[in] pcb
Typ: LONG*
Zeiger auf eine Variable, die von der Rückruffunktion auf die Anzahl der tatsächlich gelesenen oder geschriebenen Bytes festgelegt wird.
Rückgabewert
Typ: DWORD-
Die Rückruffunktion gibt null zurück, um den Erfolg anzuzeigen.
Die Rückruffunktion gibt einen Wert ungleich Null zurück, um einen Fehler anzugeben. Wenn ein Fehler auftritt, endet der Lese- oder Schreibvorgang, und das Rich Edit-Steuerelement verwirft alle Daten im PbBuff- Puffer. Wenn die Rückruffunktion einen Wert ungleich Null zurückgibt, verwendet das Rich Edit-Steuerelement das dwError Member der EDITSTREAM- Struktur, um den Wert wieder an die Anwendung zu übergeben.
Bemerkungen
Wenn Sie die EM_STREAMIN- oder EM_STREAMOUT Nachricht an ein Rich-Edit-Steuerelement senden, gibt das pfnCallback Mitglied der EDITSTREAM--Struktur einen Zeiger auf eine EditStreamCallback--Funktion an. Das Rich Edit-Steuerelement ruft die Funktion wiederholt auf, um einen Datenstrom in oder aus dem Steuerelement zu übertragen.
Wenn Sie die EM_STREAMIN- oder EM_STREAMOUT-Nachricht senden, geben Sie einen Wert für das dwCookie- Mitglied der EDITSTREAM- Struktur an. Das Rich-Edit-Steuerelement verwendet den dwCookie--Parameter, um diesen Wert an Ihre EditStreamCallback--Funktion zu übergeben. Beispielsweise können Sie dwCookie- verwenden, um ein Handle an eine geöffnete Datei zu übergeben. Die Rückruffunktion kann dann das dwCookie Handle verwenden, um aus der Datei zu lesen oder in die Datei zu schreiben.
Das Steuerelement ruft die Rückruffunktion wiederholt auf, wobei ein Teil der Daten mit jedem Aufruf übertragen wird. Das Steuerelement ruft die Rückruffunktion weiterhin auf, bis eine der folgenden Bedingungen auftritt:
- Die Rückruffunktion gibt einen Wert ungleich Null zurück.
- Die Rückruffunktion gibt null im * Pcb Parameter zurück.
- Ein Fehler tritt auf, der verhindert, dass das Rich-Edit-Steuerelement Daten in oder aus sich selbst überträgt. Beispiele sind Nichtspeichersituationen, Fehler einer Systemfunktion oder ein ungültiges Zeichen im Lesepuffer.
- Bei einem Stream-In-Vorgang enthält der RTF-Code Daten, die das Ende eines RTF-Blocks angeben.
- Bei einem Datenstromvorgang für ein einzeiliges Bearbeitungssteuerelement liest der Rückruf in einem Absatzendezeichen (CR, LF, VT, LS oder PS) vor.
Anforderungen
| Anforderung | Wert |
|---|---|
| mindestens unterstützte Client- | Windows Vista [nur Desktop-Apps] |
| mindestens unterstützte Server- | Windows Server 2003 [Nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | richedit.h |
Siehe auch
Referenz-