HttpSetRequestProperty函式會設定新的屬性,或修改指定要求上的現有屬性。
語法
HTTPAPI_LINKAGE ULONG HttpSetRequestProperty(
[in] HANDLE RequestQueueHandle,
[in] HTTP_OPAQUE_ID Id,
[in] HTTP_REQUEST_PROPERTY PropertyId,
[in] PVOID Input,
[in] ULONG InputPropertySize,
[in] LPOVERLAPPED Overlapped
);
參數
[in] RequestQueueHandle
接收要求之要求佇列的控制碼。 系統會建立要求佇列,並透過呼叫 HttpCreateRequestQueue 函式所傳回的控制碼。
[in] Id
要求的不透明識別碼。 此識別碼位於HttpReceiveHttpRequest所傳回之HTTP_REQUEST結構的RequestId成員中。
[in] PropertyId
描述所設定屬性類型 之HTTP_REQUEST_PROPERTY 列舉的成員。 這必須是下列其中一項:
| 財產 | 意義| |HttpRequestPropertyStreamError |在要求上設定資料流程錯誤。 |
[in] Input
緩衝區的指標,其中包含屬性資訊。
它必須根據所設定的屬性,指向下列其中一個屬性資訊類型。
| 財產 | 組態類型| |HttpRequestPropertyStreamError |HTTP_REQUEST_PROPERTY_STREAM_ERROR結構 |
[in] InputPropertySize
Input參數所指向之緩衝區的長度,以位元組為單位。
[in] Overlapped
針對非同步呼叫,請將 pOverlapped 設定為指向 重迭 結構;針對同步呼叫,請將它設定為 Null。
同步呼叫會封鎖直到作業完成為止,而非同步呼叫會立即傳回 ERROR_IO_PENDING ,而呼叫應用程式接著會使用 GetOverlappedResult 或 I/O 完成埠來判斷作業完成的時間。 如需使用 OVERLAPPED 結構進行同步處理的詳細資訊,請參閱 同步處理和重迭的輸入和輸出。
傳回值
如果函式成功,它會傳回 ERROR_SUCCESS。
如果函式失敗,它會傳回 系統錯誤碼。
需求
| 目標平台 | Windows |
| 標頭 | HTTP.h |
| 程式庫 | Httpapi.lib |
| Dll | Httpapi.dll |