PC SOFT

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

  • Définition
  • Procédure globale
  • Procédures globales et collections de procédures
  • Procédures globales serveur et navigateur
  • Création d'une procédure globale
  • Création depuis l'éditeur de code
  • Création depuis le volet "Explorateur de projet"
  • Afficher la liste des procédures globales
  • Suppression d'une procédure globale
  • Suppression depuis l'éditeur de code
  • Suppression depuis le volet "Explorateur de projet"
  • Test d'une procédure globale
  • Depuis l'éditeur de code
  • Depuis le volet "Explorateur de projet"
  • Procédure globale publique ou privée
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Autres
Procédures stockées
Définition
Les procédures peuvent être de deux types :
  • Procédure globale : utilisable dans tous les traitements du projet. Cette procédure globale est mémorisée dans le projet.
  • Procédure locale : utilisable dans tous les traitements dépendant de l'objet (fenêtre ou état) dans lequel cette procédure a été déclarée. Cette procédure locale est mémorisée dans l'objet.
Important : Il ne faut pas déclarer deux procédures avec le même nom (notamment une procédure globale et une procédure locale).
Rappel :
  • En WLangage, il n'existe pas de distinction entre les procédures et les fonctions. Les syntaxes de déclaration et d'utilisation décrites pour les procédures sont les mêmes pour les fonctions.
  • Versions 16 et supérieures
    Il est possible de créer des procédures multisyntaxes. Pour plus de détails, consultez Surcharge de prototype.
    Nouveauté 16
    Il est possible de créer des procédures multisyntaxes. Pour plus de détails, consultez Surcharge de prototype.
    Il est possible de créer des procédures multisyntaxes. Pour plus de détails, consultez Surcharge de prototype.
Versions 16 et supérieures
WINDEV MobileUniversal Windows 10 App Cette fonctionnalité est disponible pour les applications Windows Phone.
Nouveauté 16
WINDEV MobileUniversal Windows 10 App Cette fonctionnalité est disponible pour les applications Windows Phone.
WINDEV MobileUniversal Windows 10 App Cette fonctionnalité est disponible pour les applications Windows Phone.
Versions 17 et supérieures
WINDEV MobileiPhone/iPad Cette fonctionnalité est disponible pour les applications iPhone/iPad.
Nouveauté 17
WINDEV MobileiPhone/iPad Cette fonctionnalité est disponible pour les applications iPhone/iPad.
WINDEV MobileiPhone/iPad Cette fonctionnalité est disponible pour les applications iPhone/iPad.
Versions 18 et supérieures
WINDEVWINDEV MobileUniversal Windows 10 App Cette fonctionnalité est disponible en mode Windows Store apps.
WINDEV MobileWidget Android Cette fonctionnalité est disponible en mode Widget Android.
Nouveauté 18
WINDEVWINDEV MobileUniversal Windows 10 App Cette fonctionnalité est disponible en mode Windows Store apps.
WINDEV MobileWidget Android Cette fonctionnalité est disponible en mode Widget Android.
WINDEVWINDEV MobileUniversal Windows 10 App Cette fonctionnalité est disponible en mode Windows Store apps.
WINDEV MobileWidget Android Cette fonctionnalité est disponible en mode Widget Android.
Versions 21 et supérieures
WINDEVWINDEV MobileUniversal Windows 10 App Cette fonctionnalité est disponible en mode Universal Windows 10 App.
WINDEV MobileApple Watch Cette fonctionnalité est disponible en mode Apple Watch.
Nouveauté 21
WINDEVWINDEV MobileUniversal Windows 10 App Cette fonctionnalité est disponible en mode Universal Windows 10 App.
WINDEV MobileApple Watch Cette fonctionnalité est disponible en mode Apple Watch.
WINDEVWINDEV MobileUniversal Windows 10 App Cette fonctionnalité est disponible en mode Universal Windows 10 App.
WINDEV MobileApple Watch Cette fonctionnalité est disponible en mode Apple Watch.
Procédure globale
WINDEVWEBDEV - Code ServeurWINDEV MobileEtats et RequêtesAndroidWidget AndroidiPhone/iPadApple WatchWindows MobileUniversal Windows 10 AppJava

Procédures globales et collections de procédures

Les procédures globales sont mémorisées dans des collections de procédures, associées au projet. Chaque collection de procédures est un fichier ".WDG".
Chaque projet contient au moins une collection de procédures. Cette collection est créée par défaut lors de la création du projet.
Les procédures globales contenues dans une collection de procédures peuvent être appelées depuis tous les traitements :
  • du projet,
  • de la fenêtre ou de la page (traitements de la fenêtre / de la page, de ses champs et des procédures locales associées),
  • de l'état (traitements de l'état, de ses champs et des procédures locales associées).
Conseil : Si une procédure est utilisée par une seule fenêtre ou page, il est conseillé de décrire cette procédure comme locale à la fenêtre ou à la page. La fenêtre / page est alors "indépendante".
WEBDEV - Code ServeurWEBDEV - Code Navigateur

Procédures globales serveur et navigateur

Un projet correspondant à un site dynamique contient au moins deux collections de procédures (une "serveur" et une "navigateur").
Lors de la création du projet :
  • la collection de procédures serveur par défaut a pour nom "Procédures globales de <Nom Projet>" (fichier ".WDG").
  • la collection de procédures navigateur par défaut a pour nom : "Procédures globales de <Nom projet>_Navigateur" (fichier ".WWN").
Remarque : Une collection de procédures globale Navigateur est convertie en collection de procédures Javascript. Cette collection de procédures Javascript est enregistrée dans le répertoire "<Nom Projet>_WEB" sous le nom "<Nom Projet>.JS". Cette collection de procédures contient un code de déclaration et un code de terminaison permettant par exemple de déclarer des variables globales à la collection de procédures.
Limite : Les procédures globales serveur ne peuvent pas appeler des procédures globales navigateur et inversement.
Création d'une procédure globale

Création depuis l'éditeur de code

Pour créer une procédure globale depuis l'éditeur de code :
  • Méthode 1 :
    • Sélectionnez l'option "Insertion .. Nouvelle procédure globale" (raccourci clavier [Shift] [F4]).Sous le volet "Code", dans le groupe "Procédures", déroulez "Nouveau" et sélectionnez "Nouvelle procédure globale" (raccourci clavier [Shift] [F4]).
    • Dans la fenêtre qui s'affiche :
      • Indiquez le nom de la procédure à créer.
      • Versions 21 et supérieures
        L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
        Pour plus de détails, consultez Documentation automatique des procédures.
        Nouveauté 21
        L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
        Pour plus de détails, consultez Documentation automatique des procédures.
        L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
        Pour plus de détails, consultez Documentation automatique des procédures.
      • Versions 19 et supérieures
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
        Nouveauté 19
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
  • Méthode 2 :
    • Sélectionnez l'option "Créer une procédure .. Créer une procédure globale vide" du menu contextuel.Sélectionnez l'option "Nouveau .. Nouvelle procédure globale vide" du menu contextuel.
    • Dans la fenêtre qui s'affiche :
      • Indiquez le nom de la procédure à créer.
      • Versions 21 et supérieures
        L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
        Pour plus de détails, consultez Documentation automatique des procédures.
        Nouveauté 21
        L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
        Pour plus de détails, consultez Documentation automatique des procédures.
        L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
        Pour plus de détails, consultez Documentation automatique des procédures.
      • Versions 19 et supérieures
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
        Nouveauté 19
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
        Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
  • Versions 22 et supérieures
    Méthode 3 :
    • Positionnez-vous à la fin du code d'une procédure.
    • Tapez le prototype de la procédure à créer.
    • Validez. La procédure est automatiquement créé.
    Nouveauté 22
    Méthode 3 :
    • Positionnez-vous à la fin du code d'une procédure.
    • Tapez le prototype de la procédure à créer.
    • Validez. La procédure est automatiquement créé.
    Méthode 3 :
    • Positionnez-vous à la fin du code d'une procédure.
    • Tapez le prototype de la procédure à créer.
    • Validez. La procédure est automatiquement créé.
WEBDEV - Code ServeurWEBDEV - Code Navigateur Remarques :
  • Si le code en cours est un code serveur, la procédure globale est créée dans la collection de procédures serveur. Si le code en cours est un code navigateur, la procédure globale est créée dans la collection de procédures navigateur.
  • Pour créer directement une procédure globale serveur, sélectionnez l'option "Insertion .. Nouvelle procédure globale serveur".Pour créer directement une procédure globale serveur, sous le volet "Code", dans le groupe "Procédures", déroulez "Nouveau" et sélectionnez "Nouvelle procédure globale (Serveur)".
  • Pour créer directement une procédure globale navigateur, sélectionnez l'option "Insertion .. Nouvelle procédure globale navigateur".Pour créer directement une procédure globale navigateur, sous le volet "Code", dans le groupe "Procédures", déroulez "Nouveau" et sélectionnez "Nouvelle procédure globale (Navigateur)".
Pour transformer une partie de code déjà saisi dans une procédure globale en une procédure globale :
  1. Sélectionnez le code correspondant.
  2. Utilisez l'option "Créer une procédure .. Créer une procédure globale contenant le code sélectionné" du menu contextuel.Utilisez l'option "Nouveau .. Créer une procédure globale contenant le code sélectionné" du menu contextuel.
  3. Indiquez :
  4. La procédure est créée, le code correspondant est remplacé par l'appel de la procédure avec les paramètres nécessaires.

Création depuis le volet "Explorateur de projet"

Pour créer une procédure globale depuis le volet "Explorateur de projet" :
  1. Sélectionnez le dossier "Procédures".
  2. Sélectionnez la collection de procédures voulue.
  3. Affichez le menu contextuel de la collection de procédures et sélectionnez l'option "Nouvelle procédure globale".
  4. Dans la fenêtre qui s'affiche :
    • Indiquez le nom de la nouvelle procédure globale.
    • Versions 21 et supérieures
      L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
      Pour plus de détails, consultez Documentation automatique des procédures.
      Nouveauté 21
      L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
      Pour plus de détails, consultez Documentation automatique des procédures.
      L'option "Générer un commentaire d'en-tête" permet de générer automatiquement le commentaire du prototype de la procédure.
      Pour plus de détails, consultez Documentation automatique des procédures.
    • Versions 19 et supérieures
      Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
      Nouveauté 19
      Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
      Indiquez la portée de la procédure. Par défaut, la procédure créée est publique. Pour plus de détails, consultez le paragraphe Procédure globale publique ou privée.
  5. Validez.
WEBDEV - Code ServeurWEBDEV - Code Navigateur Pour créer une procédure globale serveur ou navigateur, sélectionnez la collection de procédures correspondante.

Afficher la liste des procédures globales

Il est possible d'afficher la liste des procédures globales en sélectionnant l'option "Affichage .. Procédures globales" (raccourci clavier [Ctrl] [F8]) de l'éditeur de code.Pour afficher la liste des procédures globales, utilisez la combinaison de touches [Ctrl] [F8] de l'éditeur de code.
Les procédures globales sont affichées dans le volet "Explorateur de projet" si ce volet est affiché.
WEBDEV - Code Navigateur Remarque : Il est possible d'afficher la liste des procédures globales navigateur en sélectionnant l'option "Affichage .. Procédures globales navigateur" (raccourci clavier [Ctrl] [Alt] [F8]) de l'éditeur de code.
WEBDEV - Code Navigateur Remarque : Pour afficher la liste des procédures globales navigateur, utilisez la combinaison de touches [Ctrl] [Alt] [F8] de l'éditeur de code.
Suppression d'une procédure globale
Versions 16 et supérieures

Suppression depuis l'éditeur de code

Pour supprimer une procédure globale depuis l'éditeur de code :
  1. Cliquez sur le bandeau de la procédure dans l'éditeur de code.
  2. Dans le menu contextuel, sélectionnez "Supprimer".
Nouveauté 16

Suppression depuis l'éditeur de code

Pour supprimer une procédure globale depuis l'éditeur de code :
  1. Cliquez sur le bandeau de la procédure dans l'éditeur de code.
  2. Dans le menu contextuel, sélectionnez "Supprimer".

Suppression depuis l'éditeur de code

Pour supprimer une procédure globale depuis l'éditeur de code :
  1. Cliquez sur le bandeau de la procédure dans l'éditeur de code.
  2. Dans le menu contextuel, sélectionnez "Supprimer".

Suppression depuis le volet "Explorateur de projet"

Pour supprimer une procédure globale depuis le volet "Explorateur de projet" :
  1. Sélectionnez le dossier "Procédures".
  2. Sélectionnez la collection de procédures voulue.
  3. Affichez le menu contextuel de la collection de procédures et sélectionnez l'option "Supprimer".
WEBDEV - Code ServeurWEBDEV - Code Navigateur Pour supprimer une procédure globale serveur ou navigateur, sélectionnez la collection de procédures correspondante.
Test d'une procédure globale

Depuis l'éditeur de code

Pour tester une procédure globale :
  1. Affichez la procédure globale sous l'éditeur de code.
  2. Cliquez sur le bouton [GO].
  3. La fenêtre de description du test de la procédure s'affiche. Cette fenêtre permet de :
    • Saisir les différents paramètres de la procédure.
    • Lancer le test de la procédure (bouton [Tester la procédure]).
    • Vérifier la valeur de retour.

Depuis le volet "Explorateur de projet"

Pour tester une procédure globale :
  1. Sélectionnez le dossier "Procédures" de l'explorateur de projet.
  2. Sélectionnez le nom de la procédure globale à tester.
  3. Sélectionnez l'option "Tester la procédure" du menu contextuel.
  4. La fenêtre de description du test de la procédure s'affiche. Cette fenêtre permet de :
    • Saisir les différents paramètres de la procédure.
    • Lancer le test de la procédure (bouton [Tester la procédure]).
    • Vérifier la valeur de retour.
Procédure globale publique ou privée
Une procédure globale est publique par défaut : elle est accessible depuis n'importe quel code.
Dans certains cas, il est nécessaire de restreindre l'accès à une procédure globale en la rendant "Privée". Dans ce cas, la procédure globale et accessible uniquement par une autre procédure globale présente dans la collection de procédures.
Versions 19 et supérieures
Lors de la création d'une procédure globale, il est possible de spécifier si la procédure est publique ou privée.
Nouveauté 19
Lors de la création d'une procédure globale, il est possible de spécifier si la procédure est publique ou privée.
Lors de la création d'une procédure globale, il est possible de spécifier si la procédure est publique ou privée.
Pour modifier le mode d'accès à une procédure globale :
  1. Sélectionnez la procédure globale dans le volet "Explorateur de projet".
  2. Dans le menu contextuel de la procédure, sélectionnez le nouveau mode d'accès :
    • publique.
    • privé.
Versions 16 et supérieures
La couleur du bandeau de la procédure change en fonction de son mode d'accès :
  • début de bandeau rouge : procédure privée.
  • début de bandeau habituel : procédure publique.
Nouveauté 16
La couleur du bandeau de la procédure change en fonction de son mode d'accès :
  • début de bandeau rouge : procédure privée.
  • début de bandeau habituel : procédure publique.
La couleur du bandeau de la procédure change en fonction de son mode d'accès :
  • début de bandeau rouge : procédure privée.
  • début de bandeau habituel : procédure publique.
Remarque : Composant externe et procédures globales privées :
L'utilisation de procédures globales privées ou publiques a un impact notamment dans les composants externes. En effet, seules les procédures explicitement privées (utilisant le mot-clé PRIVEE dans leur prototype) présentes dans un composant externe ne pourront pas être utilisées directement par le projet intégrant ce composant.
Version minimum requise
  • Version 12
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire