Les méthodes permettent de contrôler le fonctionnement d'un objet XMLHTTPRequest instancié par le navigateur Web.
Sens affectés aux paramètres des méthodes :
(E) |
Entrée |
(S) |
Sortie |
Liste des codes retour des différentes méthodes :
| _XHR_ERR_OK | L'exécution de la méthode s'est déroulée correctement. |
| _XHR_ERR_ERREUR_INATTENDUE | Une erreur inattendue s'est produite. |
| _XHR_ERR_PARAMETRE_INVALIDE | Paramètre invalide. |
| _XHR_ERR_DONNEES_TRONQUEES | Les données de la variable en sortie sont tronquées. |
| _XHR_ERR_ETAT_INVALIDE | L'appel a échoué car la requête n'était pas dans le bon état. |
Permet d'ajouter des données à un formulaire.
| Syntaxe | ||
APPELER_METHODE NomObjet AJOUTER_DONNEES_FORMULAIRE Cle Valeur CodeRetour |
||
Paramètres |
||
Cle(E) |
ALPHA(n) |
Nom de la partie données. |
Valeur(E) |
ALPHA(n) |
Données. |
CodeRetour(S) |
NUM_BIN_2 |
Code retour de la méthode. |
Permet d'annuler l'exécution de la requête. La requête doit être en cours d'exécution.
| Syntaxe | ||
APPELER_METHODE NomObjet ANNULER CodeRetour |
||
Paramètres |
||
CodeRetour(S) |
NUM_BIN_2 |
Code retour de la méthode. |
Permet d'ajouter un en-tête HTTP à la requête. La requête doit être ouverte (état _XHR_ETAT_REQUETE_OUVERTE).
| Syntaxe | ||
APPELER_METHODE NomObjet DEFINIR_ENTETE_REQUETE Nom Valeur CodeRetour |
||
Paramètres |
||
Nom(E) |
ALPHA(n) |
Nom de l'en-tête. |
Valeur(E) |
ALPHA(n) |
Valeur de l'en-tête. |
CodeRetour(S) |
NUM_BIN_2 |
Code retour de la méthode. |
Permet d'envoyer la requête en spécifiant les données du corps du message (body) associé. La requête doit être ouverte (état _XHR_ETAT_REQUETE_OUVERTE).
| Syntaxe | ||
APPELER_METHODE NomObjet ENVOYER Message CodeRetour |
||
Paramètres |
||
Message(E) |
ALPHA(n) |
Corps du message. |
CodeRetour(S) |
NUM_BIN_2 |
Code retour de la méthode. |
Permet d'envoyer la requête en associant le formulaire au corps du message. La requête doit être ouverte (état _XHR_ETAT_REQUETE_OUVERTE). Le formulaire doit avoir été constitué à l'aide des méthodes AJOUTER_DONNEES_FORMULAIRE et VIDER_DONNEES_FORMULAIRE.
Remarque : les données du formulaire sont conservées après l'exécution, vous devez explicitement le vider pour le réinitialiser.
| Syntaxe | ||
APPELER_METHODE NomObjet ENVOYER_DONNEES_FORMULAIRE CodeRetour |
||
Paramètres |
||
CodeRetour(S) |
NUM_BIN_2 |
Code retour de la méthode. |
Permet d'ouvrir la requête. La requête doit être à l'état non envoyée (_XHR_ETAT_REQUETE_NON_ENVOYEE) ou terminée (_XHR_ETAT_REQUETE_TERMINEE). En cas de succès la requête passe à l'état ouverte (état _XHR_ETAT_REQUETE_OUVERTE).
| Syntaxe | ||
APPELER_METHODE NomObjet OUVRIR Methode Url Async Utilisateur MotDePasse CodeRetour |
||
Paramètres |
||
Methode(E) |
ALPHA(n) |
Méthode d'interrogation (POST ou GET), |
Url(E) |
ALPHA(n) |
URL d'accès, |
Async(E) |
BOOL |
Exécution asynchrone, |
Utilisateur(E) |
ALPHA(n) |
Nom de l'utilisateur pour l'authentification http ou *BLANK, |
MotDePasse(E) |
ALPHA(n) |
Mot de passe de l'utilisateur, |
CodeRetour(S) |
NUM_BIN_2 |
Code retour de la méthode. |
Permet de lire la valeur d'un en-tête HTTP de la requête. La requête doit être dans un état permettant la lecture des en-têtes (état _XHR_ETAT_REQUETE_ENTETES_RECUES ou ultérieur).
| Syntaxe | ||
APPELER_METHODE NomObjet RECUPERER_ENTETE_REPONSE Nom Valeur CodeRetour |
||
Paramètres |
||
Nom(E) |
ALPHA(n) |
Nom de l'en-tête. |
Valeur(S) |
ALPHA(n) |
Valeur de l'en-tête. |
CodeRetour(S) |
NUM_BIN_2 |
Code retour de la méthode. |
Permet de lire la valeur de l'ensemble des en-têtes HTTP de la requête. La requête doit être dans un état permettant la lecture des en-têtes (état _XHR_ETAT_REQUETE_ENTETES_RECUES ou ultérieur).
| Syntaxe | ||
APPELER_METHODE NomObjet RECUPERER_ENTETES_REPONSE Valeur CodeRetour |
||
Paramètres |
||
Valeur(S) |
ALPHA(n) |
Valeur des en-têtes. |
CodeRetour(S) |
NUM_BIN_2 |
Code retour de la méthode. |
Permet de réinitialiser les données du formulaire associé à la requête.
Remarque : les données du formulaire sont conservées après l'exécution, vous devez explicitement le vider.
| Syntaxe | ||
APPELER_METHODE NomObjet VIDER_DONNEES_FORMULAIRE CodeRetour |
||
Paramètres |
||
CodeRetour(S) |
NUM_BIN_2 |
Code retour de la méthode. |