PageParamètre (Fonction)

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

Version :

Accueil | Connexion | Français

Aide / WLangage / Fonctions WLangage / Fonctions spécifiques au WEB / Fonctions de gestion des pages

Obtenir une valeur qui n'est pas reliée à un champ
Récupération des paramètres passés à une page AWP ou PHP
Exemple d'URL permettant de lancer un site WEBDEV en lui passant des paramètres
Récupération des paramètres envoyés à la page depuis une application WINDEV ou WINDEV Mobile
Sessions prélancées
PHP4

WINDEV

WEBDEV

WINDEV Mobile

Autres

Voir Aussi

PageParamètre (Fonction)

En anglais : PageParameter

Renvoie la valeur d'un paramètre passé à la page en cours. Permet par exemple de récupérer :

les paramètres d'une ligne de commande.
une valeur qui n'est pas liée à un champ (position de la souris dans une image cliquable).

Exemple

Voir des exemples supplémentaires

// Code d'initialisation du projet
SELON Majuscule(PageParamètre("PAGEDEMARRAGE"))
	CAS "LOGIN" : PageAffiche(PAGE_Identification)
	CAS "PRODUITS" : PageAffiche(PAGE_GestProd)
	AUTRES CAS : // Ne rien faire
FIN

// Récupération de la position de la souris dans une image cliquable
Paramètre est une chaîne = PageParamètre("POS") 
// Ex : Paramètre ="15,23"
x,y sont des entiers
x = ExtraitChaîne(Paramètre, 1, ",")
y = ExtraitChaîne(Paramètre, 2, ",")

// Récupération de la position de la souris dans une image cliquable
Paramètre est une chaîne = PageParamètre(1) 
// Ex : Paramètre = "POS=15,23"

Syntaxe

Récupérer la valeur d'un paramètre identifié par son nom Masquer les détails

<Résultat> = PageParamètre(<Nom du paramètre> [, <Encodage>])

<Résultat> : Chaîne de caractères

Valeur du paramètre spécifié,
Chaîne vide ("") si le paramètre n'existe pas ou n'a pas de valeur.

<Nom du paramètre> : Chaîne de caractères

Nom du paramètre dont la valeur doit être renvoyée. Dans le cas d'une page AWP, les paramètres sont automatiquement nommés par WEBDEV (P1, P2, ..., P256). Dans ce cas, la page ne doit pas contenir des champs ayant pour nom P1, P2, ..., P256.

<Encodage> : Constante optionnelle de type Entier

Mode de gestion de l'encodage de la valeur du paramètre :
paramAvecDécodage
(Valeur par défaut) La valeur du paramètre est automatiquement décodée par WEBDEV selon la norme d'encodage/décodage des URL.
paramSansDécodage La valeur brute du paramètre est renvoyée. Aucun décodage n'est effectué par WEBDEV. Cette constante peut être utilisée lorsque l'encodage de l'URL ne respecte pas les normes utilisées par WEBDEV (par exemple, problème de gestion du signe +, ...)

Récupérer la valeur d'un paramètre identifié par son indice Masquer les détails

<Résultat> = PageParamètre(<Indice du paramètre> [, <Encodage>])

<Résultat> : Chaîne de caractères

Valeur du paramètre spécifié. Cette valeur est de la forme <Nom du paramètre> = <Valeur>.
Chaîne vide ("") si le paramètre n'existe pas.

<Indice du paramètre> : Entier

Indice du paramètre dont la valeur doit être renvoyée.

<Encodage> : Constante optionnelle de type Entier

Mode de gestion de l'encodage de la valeur du paramètre :
paramAvecDécodage
(Valeur par défaut) La valeur du paramètre est automatiquement décodée par WEBDEV selon la norme d'encodage/décodage des URL.
paramSansDécodage La valeur brute du paramètre est renvoyée. Aucun décodage n'est effectué par WEBDEV. Cette constante peut être utilisée lorsque l'encodage de l'URL ne respecte pas les normes utilisées par WEBDEV (par exemple, problème de gestion du signe +, ...)

Récupérer des données spécifiques Masquer les détails

<Résultat> = PageParamètre(<Type du message>)

<Résultat> : Chaîne de caractères

Données envoyées par la fonction HTTPRequête.
Chaîne vide ("") si aucune donnée.

<Type du message> : Constante de type entier

Type des données à récupérer :
paramBuffer Récupère les données brutes reçues (envoyées par une méthode POST). Les données reçues doivent utiliser un des types MIME suivants :
"application/octet-stream".
"text/xml".
Remarque : Si cette constante est utilisée, la page peut être testée uniquement en utilisant la fonction HTTPRequête pour transmettre le message. Un simple GO de la page ne fonctionne pas.

Remarques

Obtenir une valeur qui n'est pas reliée à un champ

Par défaut, les paramètres envoyés par le navigateur sont normalement affectés à des champs du contexte, avant d'exécuter tout traitement. La fonction PageParamètre permet d'obtenir une valeur qui n'est pas reliée à un champ.

Exemple : La fonction PageParamètre permet de récupérer une position dans une image cliquable.

Pour les zones de cliquage, lors du clic de la souris, vous pouvez récupérer la position horizontale et verticale de la souris dans la zone de cliquage, avec un paramètre spécifique : "POS" (voir exemple).

Récupération des paramètres passés à une page AWP ou PHP

La fonction PageParamètre permet de récupérer la valeur des paramètres passés à la page. Selon le type de page, plusieurs possibilités existent :

Récupération selon le nom du paramètre
Récupération selon l'indice du paramètre

Cas 1 : Récupération selon le nom du paramètre
Le nom du paramètre a été précisé dans l'URL de la page.
Dans le cas d'une page AWP ou PHP, les paramètres sont automatiquement renommés par WEBDEV (P1, P2, ..., P256). Dans ce cas, la page ne doit pas contenir des champs ayant pour nom P1, P2, ..., P256.

1. Code permettant d'afficher la page en lui passant des paramètres :

// Affiche dans la page "MaPage.AWP", le 350ème élément 
// de la catégorie "Instruments"
PageAffiche(PAGE_MaPage, "Instruments", 350)

2. Code permettant de récupérer les paramètres :

// Récupération des paramètres
CategorieRecherchée est une chaîne = PageParamètre("P1")
IDRecherché est un entier = PageParamètre("P2")

Cas 2 : Récupération selon l'indice du paramètre
L'indice du paramètre correspond à l'ordre dans lequel les paramètres ont été passés dans l'URL de la page.

Cette syntaxe n'est pas disponible dans cette version.

1. Code permettant d'afficher la page en lui passant des paramètres :

// Affiche dans la page "MaPage.AWP", le 350ème élément 
// de la catégorie "Instruments"
PageAffiche(PAGE_MaPage, "Instruments", 350)

2. Code permettant de récupérer les paramètres :

// Récupération des paramètres
CategorieRecherchée est une chaîne = PageParamètre(1) 
// CategorieRecherchée = "P1=Instruments"
CategorieRecherchée = Droite(Taille(CategorieRecherchée)-3)
IDRecherché est un entier = PageParamètre(2)
// IDRecherché = "P2=350"
IDRecherché = Droite(Taille(IDRecherché)-3)

Exemple d'URL permettant de lancer un site WEBDEV en lui passant des paramètres

http://Serveur/WD300AWP/WD300AWP.EXE/CONNECT/APPLI?PARAM1=VAL1&PARAM2=VAL2&PARAM3=VAL3

Dans ce code :

serveur correspond à l'adresse du serveur,
APPLI correspond au nom du site WEBDEV,
PARAM1, PARAM2 et PARAM3 correspondent aux noms des paramètres,
VAL1, VAL2 et VAL3 correspondent à la valeur des différents paramètres.

Chaque paramètre est récupéré en WLangage, dans le code d'initialisation du projet. Pour chaque paramètre, il suffit d'utiliser la fonction PageParamètre en spécifiant le nom du paramètre à récupérer.

Par exemple :

// Récupération du paramètre ayant pour nom PARAM1
PageParamètre("PARAM1")

Récupération des paramètres envoyés à la page depuis une application WINDEV ou WINDEV Mobile

Si la valeur d'un paramètre reçu a été envoyée par une application WINDEV ou WINDEV Mobile avec la fonction HTTPRequête et a été encodée avec la fonction URLEncode, il n'est pas nécessaire de décoder cette valeur. La fonction PageParamètre fera automatiquement le décodage nécessaire (appel à la fonction URLDécode).

Sessions prélancées

Si votre projet utilise les sessions prélancées, cette fonction ne doit pas être utilisée dans l'événement "Initialisation" du projet. Cette fonction doit être utilisée dans l'événement "Initialisation lors d'une connexion à une session prélancée".

PHP4

En PHP4, pour récupérer la valeur brute des paramètres (constante paramBuffer ou constante paramSansDécodage), la directive "always_populate_raw_post_data" doit être à "on" dans le fichier de configuration de PHP (fichier php.ini).

Liste des exemples associés :

Exemples didactiques (WEBDEV) : WW_Agenda

[ + ] L'exemple WW_Agenda est un exemple d'utilisation du champ Agenda pour WEBDEV.

Composante : wd300page.dll

Voir Aussi

Version minimum requise

Version 9

Commentaires

Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 01/07/2024

Signaler une erreur ou faire une suggestion | Aide en ligne locale