Edit

Share via

InternetReadFileExA function (wininet.h)

  • Article

Reads data from a handle opened by the InternetOpenUrl or HttpOpenRequest function.

Syntax

BOOL InternetReadFileExA(
  [in]  HINTERNET           hFile,
  [out] LPINTERNET_BUFFERSA lpBuffersOut,
  [in]  DWORD               dwFlags,
  [in]  DWORD_PTR           dwContext
);

Parameters

[in] hFile

Handle returned by the InternetOpenUrl or HttpOpenRequest function.

[out] lpBuffersOut

Pointer to an INTERNET_BUFFERS structure that receives the data downloaded.

[in] dwFlags

This parameter can be one of the following values.

Value Meaning
IRF_ASYNC
 Identical to WININET_API_FLAG_ASYNC.
IRF_SYNC
 Identical to WININET_API_FLAG_SYNC.
IRF_USE_CONTEXT
 Identical to WININET_API_FLAG_USE_CONTEXT.
IRF_NO_WAIT
 Do not wait for data. If there is data available, the function returns either the amount of data requested or the amount of data available (whichever is smaller).

[in] dwContext

A caller supplied context value used for asynchronous operations.

Return value

Returns TRUE if successful, or FALSE otherwise. To get extended error information, call GetLastError. An application can also use InternetGetLastResponseInfo when necessary.

Remarks

Note  WinINet does not support server implementations. In addition, it should not be used from a service. For server implementations or services use Microsoft Windows HTTP Services (WinHTTP).
 

Note

The wininet.h header defines InternetReadFileEx as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header wininet.h
Library Wininet.lib
DLL Wininet.dll

See also

Common Functions

WinINet Functions