Format des paramètres

Cette section indique la signification et le formatage des paramètres clés utilisés dans ce manuel.

Le paramètre nomServeur est le nom ou l'adresse IP du serveur hôte (HostName), par exemple "dns.4d.com" ou "204.118.90.2". Les noms de serveurs sont convertis au moyen du système de noms de domaines. Les noms de domaines "par défaut" (primaires) et "secondaires" sont généralement indiqués dans le tableau de bord du gestionnaire TCP/IP installé. Les commandes Internet de 4D nécessitant un nom de serveur comme paramètre acceptent indifféremment son nom ("www.4d.com") ou son adresse IP ("204.118.90.2"). Le format "nom" est généralement préférable car il met l'application à l'abri d'effets indésirables liés aux modifications matérielles dans les sites distants.

Des formules mathématiques peuvent être appliquées aux adresses IP pour les convertir en entiers longs uniques. Les commandes NET_NameToAddr and NET_AddrToName (thème IC Internet) automatisent cette conversion. Cet entier long est désigné par ip_EntierLong dans ce manuel. Cette valeur n'est utilisée que dans des circonstances particulières par des développeurs établissant des communication TCP directes.

Certains développeurs préféreront également stocker des entiers longs plutôt que des noms de domaines afin d'économiser de l'espace disque. Toutefois, pour des raisons de compatibilité avec IPV6, cette astuce est déconseillée. Il est préférable de travailler avec l'adresse IP ou le nom de domaine.

Le paramètre adresseEmail est une spécification d'adresse électronique complète au format "nom_utilisateur@nom_domaine". Dans ce manuel, adresseEmail fait référence à une adresse électronique unique. Lorsqu'un paramètre d'une routine accepte une liste de plusieurs adresses, le paramètre listeAdresses est explicitement indiqué.

adresseEmail ne peut accepter qu'une seule adresse électronique. Il doit comporter à la fois le nom de l'utilisateur et le nom de domaine :

    "Felix Unger" <felix@pristine.com>
    oscar@slobs.com (Oscar Madison)

Le paramètre listeAdresses contient une ou plusieurs adresses électroniques au format décrit dans le paramètre adresseEmail, les adresses étant séparées par des virgules ou des retours chariot. La délimitation par retour chariot est utile pour fournir aux utilisateurs une zone de texte permettant de saisir ou de coller plusieurs adresses. Les trois exemples suivants génèrent une valeur $listeAdresses valide:

Le paramètre cheminLocal indique l'emplacement d'un fichier ou d'un répertoire sur l'ordinateur de l'utilisateur (Mac ou Windows).

Sur un Macintosh, les éléments à l'intérieur des dossiers sont séparés par des caractères "deux-points" (:). Par exemple, le fichier "Mon rapport" dans le dossier "Rapports" sur le disque dur "Mon disque dur" aura comme chemin d'accès "Mon disque dur:Rapports:Mon Rapport". Une spécification de répertoire sur un Macintosh doit se terminer par un caractère "deux-points". Par exemple, si vous voulez placer un nouveau rapport dans le dossier indiqué précédemment, vous devez passer la chaîne "Mon disque dur:Rapports:". La décision de faire référence à un nom de fichier ou de répertoire est liée au contexte de la commande.

Sous Windows, le principe utilisé est identique, à l'exception du fait qu'une barre oblique inversée "\" est utilisée à la place des caractères "deux-points".

Note : Avec le protocole FTP, les commandes Internet de 4D ne permettent pas de manipuler des fichiers dont le nom contient plus de 31 caractères (cf. Transfert de fichiers, Présentation).

Le cheminServeur est l'emplacement d'un fichier ou d'un répertoire sur un ordinateur fonctionnant sous le système d'exploitation Unix. Dans l'environnement Unix, les répertoires sont séparés par des barres obliques ("/"). Par exemple, le fichier "rapport.txt" dans le répertoire "rapports" du répertoire "4D" sera désigné par "/4D/rapports/rapport.txt". Le chemin d'accès d'un répertoire doit se terminer par un caractère "/". Notez qu'un chemin d'accès complet commence par une "/" qui représente la racine du volume.

Note : Avec le protocole FTP, les noms des fichiers manipulés par les commandes Internet de 4D ont une taille limitée. Pour plus d'informations reportez-vous à la section Transfert de fichiers, Présentation.

La plupart des commandes Internet de 4D, quel que soit leur thème, utilisent un numéro d'ID permettant de référencer de façon unique leur session de travail. Toutes les commandes qui doivent s'exécuter dans le cadre d'une session y font référence par l'intermédiaire de l'ID de la session.

Les numéros d'"ID" sont propres à chaque classe de commande (SMTP, POP3, IMAP, FTP, TCP, UDP). Toutefois, il est possible de passer directement une référence de connexion POP3, IMAP ou FTP aux commandes TCP de bas niveau et inversement. Pour plus d'informations, reportez-vous à la section Routines de bas niveau, Présentation.

Toutes les commandes Internet de 4D (à l'exception de IT_ErrorText et IT_Version) retournent un entier comme résultat de la fonction. Cet entier contient un numéro d'erreur que la commande doit retourner à la base de données 4D. Si une commande aboutit, un zéro est renvoyé. Sinon, un code d'erreur est renvoyé. L'Annexe C, Codes d'erreurs de 4D Internet Commands fournit la liste des codes d'erreurs des commandes Internet de 4D.