IStream_Read関数 (shlwapi.h)

指定したストリームからバイトを読み取り、すべてのバイトが正常に読み取られたかどうかを示す値を返します。

構文

LWSTDAPI IStream_Read(
  [in]  IStream *pstm,
  [out] void    *pv,
  [in]  ULONG   cb
);

[in] pstm

種類: IStream*

読み取るストリームの IStream インターフェイスへのポインター。

[out] pv

型: VOID*

pstm からストリームデータを受信するバッファーへのポインター。このバッファーは、サイズが cb バイト以上である必要があります。

[in] cb

種類: ULONG

関数が入力ストリームから読み取ろうとするデータのバイト数。

型: HRESULT

関数がストリームから指定したバイト数を正常に読み取った場合は S_OK を返し、それ以外の場合は COM エラーコードを返します。特に、読み取り試行が成功したが、読み取られた cb バイト未満の場合、関数は E_FAILを返します。

この関数は、ISequentialStream::Read メソッドを呼び出して、指定したストリームからバッファーにデータを読み取ります。関数が何らかの理由で失敗した場合、出力バッファーの内容と入力ストリーム内の読み取りポインターの位置は未定義になります。

要件	値
サポートされている最小のクライアント	Windows 2000 Professional、Windows XP [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server、Windows Server 2003 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	shlwapi.h
[DLL]	Shlwapi.dll (バージョン 5.0 以降)