Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.53 KB

WinHttpQueryDataAvailable.md

File metadata and controls

55 lines (36 loc) · 1.53 KB

Home

Function name : WinHttpQueryDataAvailable

Group: HTTP Functions (WinHTTP) - Library: winhttp

The WinHttpQueryDataAvailable function returns the number of bytes of data that are immediately available to be read with WinHttpReadData.

Code examples:

Custom HttpRequest class (WinHTTP)

Declaration:

BOOL WinHttpQueryDataAvailable(
  HINTERNET hRequest,
  LPDWORD lpdwNumberOfBytesAvailable
);

FoxPro declaration:

DECLARE INTEGER WinHttpQueryDataAvailable IN winhttp;
	INTEGER hRequest,;
	INTEGER @lpdwNumberOfBytesAvailable

Parameters:

hRequest [in] Valid HINTERNET handle, as returned by WinHttpOpenRequest.

lpdwNumberOfBytesAvailable [out, optional] Pointer to an unsigned long integer variable that receives the number of available bytes.

Return value:

Returns TRUE if the function succeeds, or FALSE otherwise.

Comments:

MSDN: WinHttpReceiveResponse must have been called for this handle and have completed before WinHttpQueryDataAvailable is called.

This function returns the number of bytes of data that are available to read immediately by a subsequent call to WinHttpReadData. If no data is available and the end of the file has not been reached (for a synchronous session) the request waits until data becomes available.