HttpSetRequestProperty, fonction (http.h)
La fonction HttpSetRequestProperty définit une nouvelle propriété ou modifie une propriété existante sur la requête spécifiée.
Syntaxe
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
);
Paramètres
[in] RequestQueueHandle
Handle de la file d’attente de requêtes sur laquelle la demande a été reçue. Une file d’attente de requêtes est créée et son handle est retourné par un appel à la fonction HttpCreateRequestQueue .
[in] Id
ID opaque de la demande. Cet ID se trouve dans le membre RequestId de la structure HTTP_REQUEST retournée par HttpReceiveHttpRequest.
[in] PropertyId
Membre du HTTP_REQUEST_PROPERTY énumération décrivant le type de propriété défini. Il doit s’agir de l’un des éléments suivants :
| Propriété | Signification | | HttpRequestPropertyStreamError | Définit une erreur de flux sur la demande. |
[in] Input
Pointeur vers la mémoire tampon qui contient les informations de propriété.
Elle doit pointer vers l’un des types d’informations de propriété suivants en fonction de la propriété définie.
| Propriété | Type de configuration | | HttpRequestPropertyStreamError | HTTP_REQUEST_PROPERTY_STREAM_ERROR structure |
[in] InputPropertySize
Longueur, en octets, de la mémoire tampon pointée par le paramètre Input .
[in] Overlapped
Pour les appels asynchrones, définissez pOverlapped pour qu’il pointe vers une structure CHEVAUCHEMENT . pour les appels synchrones, définissez-le sur NULL.
Un appel synchrone se bloque jusqu’à ce que l’opération soit terminée, tandis qu’un appel asynchrone retourne immédiatement ERROR_IO_PENDING et l’application appelante utilise alors les ports d’achèvement GetOverlappedResult ou E/S pour déterminer quand l’opération est terminée. Pour plus d’informations sur l’utilisation des structures OVERLAPPED pour la synchronisation, consultez Synchronisation et entrée et sortie superposées.
Valeur retournée
Si la fonction réussit, elle retourne ERROR_SUCCESS.
Si la fonction échoue, elle retourne un code d’erreur système.
Configuration requise
Plateforme cible | Windows |
En-tête | http.h |
Bibliothèque | Httpapi.lib |
DLL | Httpapi.dll |