HTTPReadFragmentFromCache 函式 (http.h)
HttpReadFragmentFromCache 函式會從 HTTP Server API 快取擷取具有指定名稱的回應片段。
語法
HTTPAPI_LINKAGE ULONG HttpReadFragmentFromCache(
[in] HANDLE RequestQueueHandle,
[in] PCWSTR UrlPrefix,
[in] PHTTP_BYTE_RANGE ByteRange,
[out] PVOID Buffer,
[in] ULONG BufferLength,
[out] PULONG BytesRead,
[in] LPOVERLAPPED Overlapped
);
參數
[in] RequestQueueHandle
處理與指定回應片段相關聯的要求佇列。 系統會建立要求佇列，並透過呼叫 HttpCreateRequestQueue 函式傳回其句柄。
Windows Server 2003 SP1 和 Windows XP SP2： 要求佇列的句柄是由 HttpCreateHttpHandle 函式所建立。
[in] UrlPrefix
UrlPrefix 字串的指標，其中包含要擷取之片段的名稱。 這必須符合先前成功呼叫 HttpAddFragmentToCache 時所使用的 UrlPrefix 字串。
[in] ByteRange
HTTP_BYTE_RANGE 結構的選擇性指標，表示要傳回之指定片段和位元組計數中的起始位移。 如果未使用則為 NULL，在此情況下會傳回整個片段。
[out] Buffer
函式將要求片段複製到其中之緩衝區的指標。
[in] BufferLength
pBuffer 緩衝區的大小，以位元組為單位。
[out] BytesRead
可接收要寫入輸出緩衝區之位元組數目的變數選擇性指標。 如果 BufferLength 小於這個數位，則呼叫會失敗並傳回 ERROR_INSUFFICIENT_BUFFER，而 pBytesRead 所指向的值可用來判斷呼叫成功所需的緩衝區長度下限。
使用 pOverlapped 進行異步呼叫時，請將 pBytesRead 設定為 NULL。 否則，當 pOverlapped 設定為 NULL 時， pBytesRead 必須包含有效的記憶體位址，而且不能設定為 NULL。
[in] Overlapped
針對異步呼叫，請將 pOverlapped 設定為指向 OVERLAPPED 結構，或針對同步呼叫，將它設定為 NULL。
同步呼叫會封鎖快取作業，直到快取作業完成為止，而異步呼叫會立即傳回ERROR_IO_PENDING，然後呼叫應用程式會使用 GetOverlappedResult 或 I/O 完成埠來判斷作業何時完成。 如需使用 重疊 結構進行同步處理的詳細資訊，請參閱 同步處理和重疊的輸入和輸出。
傳回值
如果函式成功，傳回值會NO_ERROR。
如果以異步方式使用函式，ERROR_IO_PENDING的傳回值表示快取要求已排入佇列，並稍後透過一般重疊的 I/O 完成機制完成。
如果函式失敗，傳回值就是下列其中一個錯誤碼。
| 值 | 意義 |
|---|---|
|
提供的一或多個參數格式為無法使用。 |
|
pBuffer 指向的緩衝區太小，無法接收所有要求的數據;pBytesRead 會指向所需的緩衝區大小，除非它是NULL 或呼叫是異步的。 在異步呼叫的情況下，GetOverLappedResult 函式的 lpNumberOfBytesTransferred 參數所指向的值會設定為所需的緩衝區大小。 |
|
WinError.h 中定義的 系統錯誤碼 。 |
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | Windows Vista、Windows XP SP2 [僅限傳統型應用程式] |
| 最低支援的伺服器 | Windows Server 2003 [僅限桌面應用程式] |
| 目標平台 | Windows |
| 標頭 | http.h |
| 程式庫 | Httpapi.lib |
| Dll | Httpapi.dll |