Put - Méthode

Présentation

Type :	Méthode
Disponible à partir de :	V1.0.0.0

Tâche

La méthode Put lance la méthode HTTP pour remplacer les représentations de la ressource cible par la charge utile de la requête.

Description fonctionnelle

L’en-tête par défaut de la requête HTTP est créé à l’aide des entrées i_sHost (obligatoire) et i_sResource. Si des informations supplémentaires doivent être ajoutées à l’en-tête, elles doivent être transmises par l’intermédiaire de l’entrée i_anyAdditionalHeader. Les données affectées à cette entrée ne sont pas vérifiées. Au niveau de l’entrée i_anyResponseBuffer, vous devez affecter une mémoire tampon de taille suffisante pour stocker l’intégralité de la réponse reçue du serveur.

La valeur renvoyée par la méthode est de type BOOL et indique si l’exécution de la méthode a abouti (TRUE) ou non (FALSE). Évaluez les messages de diagnostic de la méthode, si la valeur renvoyée est FALSE. Une erreur indiquée par ces messages n’exige aucune réinitialisation. La propriété State doit être utilisée pour obtenir l’état du traitement.

Un appel de la méthode Put n’est autorisé qu’à l’état Connected.

Transition d'état du client

Phase	Description
1	État initial : Connected
2	Appel de fonction
3	État : SendingRequest, sinon une erreur est détectée
4	État final : ResponseAvailable, sinon une erreur est détectée

NOTE : Si des modifications sont apportées en ligne alors que le bloc fonction traite une requête Put, l’exécution est annulée pour éviter une éventuelle violation d’accès due au traitement d’adresses de pointeur erronées.

Interface

Entrée	Type de données	Description
i_sResource	STRING[GPL.Gc_uiMaxLengthOfResource]	Spécifie la ressource sur l’hôte à atteindre par la requête.
i_sHost	STRING[GPL.Gc_uiMaxHostSize]	Spécifie l'adresse de l'hôte, et si nécessaire, étendue au port.
i_anyAdditionalHeader	ANY_STRING	Spécifie les en-têtes supplémentaires à ajouter à la requête HTTP.
i_anyContent	ANY	Affecte la mémoire tampon dans laquelle est stocké le contenu à soumettre avec la requête HTTP.
i_udiContentLength	UDINT	Longueur du contenu en octets.
i_anyResponseBuffer	ANY	Mémoire tampon permettant de stocker la réponse du serveur.

Sortie	Type de données	Description
q_xError	BOOL	Si cette sortie est TRUE, une erreur a été détectée. Pour plus d'informations, reportez-vous à q_etResult et q_etResultMsg.
q_etResult	ET_Result	Fournit des informations de diagnostic et d'état sous la forme d'une valeur numérique.
q_sResultMsg	STRING[80]	Fournit des informations de diagnostic et d'état sous la forme d'un message textuel.