ASKUI

Sommaire


Askui permet d'exécuter une action prédéterminée sur le poste client. La liste des actions est référencée ci-dessous.  

 

Syntaxe

   Askuiretour=""with action, liste_param

 

Paramètres

Elément

Description

Restrictions

retour

retour d'information sous forme d'unechaîne de caractères

spacer.gif (822 octets)

action

code action : chaîne de caractères sousla forme :
"UIAsk="+chr$(1)+"valeur_action"

spacer.gif (822 octets)

liste_param

Liste deid_param séparés par lecaractère ','.

Les expressions doivent êtrealphanumériques et sont limitées à 255.

id_param

paramètre : chaîne de caractères sous laforme :
"cd_param="+chr$(1)+"valeur_param"

Les expressions doivent êtrealphanumériques et sont limitées à 255.

 

Exemples

# Exemple 1 : copier un fichier excel
# duposte client vers le dossier TMP du serveur
# pré-positionner le dossier courant de la fenêtre de sélection de fichier
# par le dossier "mes documents" du poste client   
Local char RETOUR(250)
Askui RETOUR="" With "UIAsk="+chr$(1) + "AskPutFile",
& "UIRemotePath="+ chr$(1) + "TMP",
& "UILocalFileExts="+ chr$(1) + "xls",
& "UILocalPath="+chr$(1) + "#myDocuments"

# Exemple 2 : désigner un fichier word
# pré-positionner le dossier courant de la fenêtre de sélection de fichier
# par le dossier "mes documents" du poste client   
Local char RETOUR (250)
Askui RETOUR="" With "UIAsk="+chr$(1) + "AskSelFile",
& "UILocalFileExts="+ chr$(1) + "doc",
& "UILocalPath="+chr$(1) + "#myDocuments"

# Exemple 3 : lire un fichier texte du poste client   
Local Clbfile RETOUR(10)
Setlob RETOUR With ""
Askui RETOUR With "UIAsk="+chr$(1) + "AskReadTextFile",
& "UILocalFileExts="+ chr$(1) + "txt"

# Exemple 4 : lancer une commande shell sur le poste client   
Local Clbfile RETOUR(10)
Setlob RETOUR With ""
Askui RETOUR With "UIAsk="+chr$(1) + "AskExecShell",
& "UILocalShell="+ chr$(1) + "AdxOfficemodule.hta -cmd xlsinsert -input 'TMP/data.csv'"

# Exemple 5 : copier un fichier "200406.etebac" 
# du dossier BANQ du dossier courant du serveur vers le poste client 
# pré-positionner le dossier courant de la fenêtre de sélection de fichier
# par le dossier "mes documents" du poste client   
Local char RETOUR(250)
Askui RETOUR="" With "UIAsk="+chr$(1) + "AskGetFile",
& "UIRemotePathFile="+ chr$(1) + "BANQ,200406,etebac",
& "UIRemoteBinary="+ chr$(1) + "0",

& "UILocalFileName="+ chr$(1) + "200406.etebac",
& "UILocalPath="+chr$(1) + "#myDocuments"

Description et commentaires

Askuipermet de piloter le client. Le client reçoit (via le moteur) l'ordre d'exécuter unAskui. Il interprète les paramètres associés, et il prend en charge le transfert ou l'ouverture du fichier.

Askuipermet de lancer l'une des actions suivantes :

Une seule action peut être précisée à la fois.

En retour,  nous avons un code nous précisant que l'action s'est bien déroulée ou pas. En cas de transfert ou de sélection de fichier, on aura enretour, le nom et chemin du fichier de destination. En cas de lecture d'unfichier texte, on aura en retour, un clob avec le contenu du fichier texte. En cas delancement d'une commande shell, on aura en retour, un clob contenant la sortie standard du processus (stdout) et la sorite des erreurs ( stderr). 

 

action :

Ce paramètre permet d'identifier l'action à lancer sur le client.

Les actions disponibles sont les suivantes :

Action

Description

AskPutFile

Transfèreun fichier du poste client vers le serveur.
Un fenêtre de sélection s'ouvre pour préciser le fichier du poste client à transférer. 

AskGetFile

Transfère un fichier du serveur vers le poste client.  en demandant à l'utilisateur de Un fenêtre de sélection s'ouvre pour préciser le nom du fichier à écrire sur le poste client ainsi que le répertoire.  

AskSelFile

Sélection d'un fichier du poste client

AskReadTextFile

Lecture d'un fichier texte sur le poste client

AskExecShell

Lancement d'une commande Shell sur le poste client et retourne, dans une chaîne d'au plus 250 caractères, le stdout et le stderr

 

id_param

Les paramètres disponibles par action sont les suivants :

Action

Paramètres

 Oblig.

AskPutFile

UILocalFileName

Nom du fichier sur le poste client 
UILocalFileExtsExtension(s) pour filtrer les fichiers à afficher
UILocalPathRépertoire sur le poste client 
UIRemoteFileNameNom du fichier sur le serveur
UIRemotePath ouiRépertoire sur le serveur
UIRemoteOverWrite  Flag autorisant la réécriture du fichier sur le serveur

AskGetFile

UIRemotePathFile

 ouiRépertoire et Nom du fichier sur le serveur
UIRemoteBinaryFlag indiquant que le contenu du fichier est binaire
UILocalFileNameNom du fichier sur le poste client 
UILocalPathRépertoire sur le poste client 

AskSelFile

 

UILocalFileName

Nom du fichier sur le poste client 
UILocalFileExtsExtension(s) pour filtrer les fichiers à afficher
UILocalPathRépertoire sur le poste client 

AskExecShell

UILocalShell

 

 

 

 

Explication de chaque paramètre : 

Paramètres

Description

UILocalFileName

Paramètre optionnel 
Nom et extension du fichier à lire pour désigner explicitement le fichier sur le client
Ce nom sert à pré-charger la fenêtre de sélection sur ce fichier.
L'utilisateur est libre de choisir un autre fichier.

UILocalFileExts

Paramètre optionnel
Liste des extensions acceptées séparées par le caractère";"
Permet d'effectuer un filtre des fichiers à afficher dans la fenêtre de sélection

Ce paramètre est pris en compte, si le paramètre UILocalFileName n'est pas renseigné. 

UILocalPath

Paramètre optionnel
Chemin complet ou partiel du dossier ou le fichier sur le client.
Ce chemin sert à pré-positionner la fenêtre de sélection dans un dossier.
L’utilisateur est libre de se déplacer.
Ce chemin est exprimé soit explicitement, soit en faisant référence à une variable d’environnement, soit en faisant référence à un identifiant d’un des dossiers standards (Special Folders) du poste client.

·        
 « TMP » désigne le sous-dossier « TMP » du dossier d’installation
·        
« D:\temp\Adonix » désigne un dossier du disque D du poste
·        
« $HOMEPATH » désigne le dossier dont le chemin est contenu dans la variable d’environnement HOMEPATH
·        « #myDocuments » désigne le dossier « mes document »

UIRemoteFileName

Paramètre optionnel 
Nom et extension du fichier à écrire sur le serveur.
Si ce paramètre est absent, on écrit sur le serveur un fichier de même nom que celui du client. 

UIRemotePath

Chemin complet oupartiel du dossier sur le serveur ou doit être stocké le fichier. Accepte la formecanonique Adonix : 
« répertoire, nom_fic, extens [, appli [, vol [ , mach ] ] ] »
· « TMP » désigne le sous-dossier « TMP »du dossier adonix courant
· « /var/adonix/import » désigne un dossier existantdans le filesystem d’un serveur unix
· « c:\temp\import » désigne un dossier existant dansle filesystem d’un serveur Windows
· « \\groupserver\pub\impot » désigne un dossierexistant  dans un volume partagéd’un serveur Windows
« TMP,,, X3 » forme canonique du sous dossier TMP du dossier Adonix X3

UIRemoteOverWrite

Paramètre optionnel
yes/no, 0/1
Indicateur permettant d’autoriser ou non l’écrasement du fichier sur le serveur.

UIRemotePathFile

Chemin complet oupartiel du fichier à transférer : 
· « TMP/toto.txt » désigne le fichier « toto.txt » présent dans le sous-dossier "TMP" du dossier Adonix courant.
· « /var/adonix/export/zzz.csv » désigne le fichier "zzz.csv" présent dans le dossier "/var/adonix/export/" du filesystem d’un serveur unix
. « répertoire, nom_fic, extens [, appli [, vol [ , mach ] ] ] » forme canonique Adonix désignant le fichier "nom_fic.extens" dans le sous-répertoire "répertoire" du dossier courant. 

UIRemoteBinary

Paramètre optionnel
yes/no, 0/1
Indique que le contenu du fichier est binaire. 
le client windows ne tient pas compte de cet argument.

UILocalshell

La commande à lancer


I
dentifiants possibles de dossiers standards (Special Folders) du poste client : 

#AllUsersDesktop
The file system directory that contains files and folders that appear on the desktop for all users. 
A typical path is C:\Documents and Settings\All Users\Desktop.

#AllUsersStartMenu
The file system directory that contains the programs and folders that appear on the Start menu for all users. 
A typical path is C:\Documents and Settings\All Users\Start Menu.

#AllUsersPrograms
The file system directory that contains the directories for the common program groups that appear on the Start menu for all users. 
A typical path is C:\Documents and Settings\All Users\Start Menu\Programs.

#AllUsersStartup
The file system directory that contains the programs that appear in the Startup folder for all users. 
A typical path is C:\Documents and Settings\All Users\Start Menu\Programs\Startup.

#Desktop
The file system directory used to physically store file OBJects on the desktop (not to be confused with the desktop folder itself). 
A typical path is C:\Documents and Settings\username\Desktop.

#Favorites :
The file system directory that serves as a common repository for the user's favorite items. 
A typical path is C:\Documents and Settings\username\Favorites.

#Fonts
A virtual folder containing fonts. 
A typical path is C:\Windows\Fonts.

#MyDocuments
The file system directory used to physically store a user's common repository of documents. 
A typical path is C:\Documents and Settings\username\My Documents.

#NetHood
A file system directory containing the link OBJects that may exist in the My Network Places virtual folder. It is not the same as CSIDL_NETWORK, which represents the network namespace root. 
A typical path is C:\Documents and Settings\username\NetHood.

#PrintHood
The file system directory that contains the link OBJects that can exist in the Printers virtual folder. 
A typical path is C:\Documents and Settings\username\PrintHood.

#Programs
The file system directory that contains the user's program groups (which are themselves file system directories). 
A typical path is C:\Documents and Settings\username\Start Menu\Programs.

#Recent
The file system directory that contains shortcuts to the user's most recently used documents. 
A typical path is C:\Documents and Settings\username\My Recent Documents.

#SendTo
The file system directory that contains Send To menu items. 
A typical path is C:\Documents and Settings\username\SendTo.

#StartMenu :
 
The file system directory containing Start menu items. 
A typical path is C:\Documents and Settings\username\Start Menu.

#Startup
The file system directory that corresponds to the user's Startup program group. The system starts these programs whenever any user logs onto Windows NT or starts Windows 95. 
A typical path is C:\Documents and Settings\username\Start Menu\Programs\Startup.

#Template
The file system directory that serves as a common repository for document templates. 
A typical path is C:\Documents and Settings\username\Templates. 

 

retour :

Ce paramètre permet d'identifier la variable qui contiendra les informationsde retour de l'instruction.

En retour, l'instruction nous envoie les informations suivantes :

Action

Valeur

Signification

AskPutFile

0

Aucun transfert

1,répertoire,nom_fic,extens[,appli]

un fichier a été transféré
+ nom du fichier transféré sur le serveur sous la forme canonique ( cf. Filpath )

-1

erreur inattendue

-91

le répertoire indiqué est inexistant

-92

l'accès au répertoire indiqué n'est pas autorisé

-93

le fichier désigné existe déjà;opération interdite

-94le fichier indiqué est inexistant

-99

demande de service non supportée

AskGetFile

0

Aucun transfert

1,chemin local du fichier écrit

un fichier a été transféré
+ nom du fichier transféré sur le client sous la forme canonique ( cf. Filpath )

-1

erreur pendant le transfert ou sur l'écriture du fichier sur le poste client

-91

le répertoire indiqué est inexistant

-92

l'accès au répertoire indiqué n'est pas autorisé

-94le fichier indiqué est inexistant
-99demande de service non supportée


AskSelFile

0

Aucun fichier sélectionné

1,chemin du fichier désigné

1 fichier a été sélectionné
+ nom du fichier sélectionné sur le client sous la forme canonique ( cf. Filpath )
-99demande de service non supportée

AskReadTextFile

texte

Texte UTF-8 contenu dans le fichier sélectionné

-99

demande de service non supportée

AskExecShell

texte

le stdout et le stderr en UTF-8

-99

demande de service non supportée

 

Nouveautés de la version 142

C'est une nouvelle instruction.

 

Erreurs associées

Erreur

Description

 

 

 

Mots-clés associés

  GETUI - CALLUI


SOMMAIRE

Adonix X3(r) L4G
Copyright (c) Adonix 1999 - All rights reserved