IInternetProtocol::Read Method

Reads data retrieved by the pluggable protocol handler.

Syntax

HRESULT Read(
    LPVOID pv,
    ULONG cb,
    ULONG *pcbRead
);

Parameters

pv

[out] Address of the buffer where the information will be stored.

cb

[in] ULONG value that indicates the size of the buffer.

pcbRead

[out] Address of a ULONG value that indicates the amount of data stored in the buffer.

Return Value

Returns one of the following values:

INET_E_DATA_NOT_AVAILABLE There is no more data available from the server, but more data was expected.

INET_E_DOWNLOAD_FAILURE The read failed.

E_PENDING The read operation is pending.

S_OK The read was successful, but there is still additional data available.

S_FALSE All of the data has been completely downloaded.

Remarks

Developers who are implementing an asynchronous pluggable protocol must be prepared to have their implementation of IInternetProtocol::Read continue to be called a few extra times after it has returned S_FALSE.

INET_E_DATA_NOT_AVAILABLE	There is no more data available from the server, but more data was expected.
INET_E_DOWNLOAD_FAILURE	The read failed.
E_PENDING	The read operation is pending.
S_OK	The read was successful, but there is still additional data available.
S_FALSE	All of the data has been completely downloaded.