RECEVOIR PAQUET

La commande RECEVOIR PAQUET lit des caractères depuis un port série ou un document.

Si docRef est spécifié, la commande récupère des données depuis un document ouvert par la fonction Ouvrir document, Creer document ou Ajouter a document. Si docRef est omis, la commande récupère des données depuis un port série ou un document ouvert par la commande REGLER SERIE.

Dans tous les cas, les caractères lus sont retournés dans la variable réceptVar, qui doit être une variable de type Texte, Alpha ou BLOB. Si les données ont été envoyées par la commande ENVOYER PAQUET, le type doit correspondre à celui du paquet envoyé.

Notes

• Si le paquet reçu est de type BLOB, la commande ne tient pas compte du jeu de caractères éventuellement défini par la commande UTILISER FILTRE. Le BLOB est retourné sans aucune modification.
• Si le paquet reçu est de type texte, la commande RECEVOIR PAQUET prend en charge les BOM (Byte Order Mark). Dans ce cas, si le jeu de caractères courant est de type Unicode (UTF-8, UTF-16 ou UTF-32), 4D tente d’identifier une BOM parmi les premiers octets reçus. Si elle est détectée, elle est filtrée de la variable réceptVar et 4D utilise le jeu de caractères qu’elle définit au lieu du jeu de caractères courant.

Si vous voulez recevoir un nombre prédéfini d'octets, passez ce nombre dans le paramètre nbOctets. Si la variable réceptVar est de type Texte, vous pouvez lire en un seul appel jusqu'à 2 Go de texte (limite théorique).

Si vous voulez recevoir des données jusqu'à ce qu'une chaîne de caractères (comportant un ou plusieurs caractères) soit lue, passez-la dans le paramètre stopCar (la chaîne n'est pas retournée dans réceptVar).
Dans ce cas, si la chaîne de caractères spécifiée par stopCar n'est pas trouvée :

• lorsque RECEVOIR PAQUET lit un document, l'exécution de la commande se terminera à la fin du document.
• lorsque RECEVOIR PAQUET lit des données en provenance du port série, la commande s'exécutera indéfiniment jusqu'à ce que le délai d'attente (s'il est fixé) soit écoulé (cf. la commande FIXER TIMEOUT) ou que l'utilisateur interrompe la réception (voir ci-dessous).

Pendant l'exécution d'un RECEVOIR PAQUET, l'utilisateur peut interrompre l'opération en appuyant sur les touches Ctrl+Alt+Maj (sous Windows) ou Commande+Option+Maj (sous Mac OS). Cette interruption génère une erreur -9994 que vous pouvez intercepter à l'aide d'une méthode installée par la commande APPELER SUR ERREUR. Généralement, vous devez gérer les interruptions d'une réception uniquement lors d'une communication série.

Lors de la lecture d'un document, le premier RECEVOIR PAQUET commence par lire le début du document. La lecture des paquets suivants débute au caractère situé immédiatement après le dernier octet lu.

Note : Ce fonctionnement est valide avec un document ouvert par REGLER SERIE. Cependant, pour un document ouvert par Ouvrir document, Creer document ou Ajouter a document, vous pouvez aussi utiliser les commandes Position dans document et CHANGER POSITION DANS DOCUMENT pour connaître et modifier la position à laquelle, dans le document, la prochaine écriture (ENVOYER PAQUET) ou lecture (RECEVOIR PAQUET) aura lieu.

En cas de tentative de lecture après la fin d'un document, RECEVOIR PAQUET retourne les données lues jusqu'à ce point et la variable système OK prend la valeur 1. Les RECEVOIR PAQUET suivants retourneront une chaîne vide et OK prendra la valeur zéro.

L'exemple suivant lit 20 caractères depuis un port série et les place dans la variable RécupVingt :

L'exemple suivant lit des données depuis le document référencé par la variable MonDoc et les place dans la variable vData. La commande récupère les données jusqu'à ce qu'elle rencontre un retour chariot :

L'exemple suivant lit des données du document référencé par la variable MonDoc et les place dans la variable vData. La commande récupère les données jusqu'à ce qu'elle rencontre une balise HTML de fin de tableau (</TD>) :

L'exemple suivant lit des données d'un document et les place dans des champs. Les données sont stockées dans des champs de longueur fixe. La méthode fait appel à une sous-routine pour éliminer les espaces superflus (situés derrière les valeurs). Le code de la sous-routine est présenté après la méthode :

Les espaces superflus derrière les valeurs sont éliminés par la méthode suivante, appelée Elimine :

Après un appel à RECEVOIR PAQUET, la variable système OK prend la valeur 1 si le paquet est reçu sans erreur. Sinon, OK prend la valeur 0.