IStreamAsync::WriteAsync-Methode (shobjidl.h)

  • Artikel

Schreibt Informationen asynchron in einen Stream. Beispielsweise implementiert die Shell diese Methode für Dateielemente, wenn sie asynchron übertragen werden.

Syntax

HRESULT WriteAsync(
  [in]  const void   *lpBuffer,
  [in]  DWORD        cb,
  [out] LPDWORD      pcbWritten,
  [in]  LPOVERLAPPED lpOverlapped
);

Parameter

[in] lpBuffer

Typ: const void*

Ein Zeiger auf einen Puffer der Größe cb Bytes, der die Informationen enthält, die in den Stream geschrieben werden sollen.

[in] cb

Art: DWORD

Die Größe des Puffers, auf den lpBuffer in Bytes verweist.

[out] pcbWritten

Typ: LPDWORD

Zeiger auf einen DWORD-Wert , der bei erfolgreicher Rückgabe der Methode die tatsächliche Anzahl der in den Stream geschriebenen Bytes angibt. Dieser Wert kann NULL sein, wenn diese Informationen nicht benötigt werden.

[in] lpOverlapped

Typ: LPOVERLAPPED

Ein Zeiger auf eine OVERLAPPED-Struktur , die Informationen enthält, die im asynchronen Schreibvorgang verwendet werden.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

WriteAsync sollte das vom hEvent-Member der OVERLAPPED-Struktur angegebene Ereignis auf einen nicht signalierten Zustand zurücksetzen, wenn der Eingabe-/Ausgabevorgang (E/A) gestartet wird.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shobjidl.h