Différences entre les versions de « Accueil Composant »

De Wiki de Lapalys
Aller à la navigation Aller à la recherche
m (A protégé « Accueil Composant » ([edit=sysop] (infini) [move=sysop] (infini)))
Ligne 5 : Ligne 5 :
 
D'une manière générale, pour activer le composant dans votre logiciel, il suffit d'exécuter la fonction "bComposantInit" du composant (attention, chaque composant possède cette fonction et chaque composant doit être initialisé de la même manière).  L'initialisation du composant ne doit se faire qu'une fois au démarrage de votre logiciel ou avant la première utilisation des fonctions du composant.
 
D'une manière générale, pour activer le composant dans votre logiciel, il suffit d'exécuter la fonction "bComposantInit" du composant (attention, chaque composant possède cette fonction et chaque composant doit être initialisé de la même manière).  L'initialisation du composant ne doit se faire qu'une fois au démarrage de votre logiciel ou avant la première utilisation des fonctions du composant.
  
== Fonction 'bComposantInit' ==
+
== Fonction 'bClapInit' ==
  
 
;Résumé :  
 
;Résumé :  
Ligne 12 : Ligne 12 :
  
 
;Syntaxe :
 
;Syntaxe :
:[ <Résultat> = ] bComposantInit (<sCléLicence> est chaîne [, <sTransactionPaypal> est chaîne])
+
:[ <Résultat> = ] bClapInit (<sCléLicence> est chaîne [, <sTransactionPaypal> est chaîne])
  
  
Ligne 22 : Ligne 22 :
 
;Valeur de retour :
 
;Valeur de retour :
 
booléen :  
 
booléen :  
: vrai si le composant est bien initialisé, faux dans le cas contraire (message d'erreur peut être récupéré par l'instruction sComposantErreur décrite ci-dessous).
+
: vrai si le composant est bien initialisé, faux dans le cas contraire (message d'erreur peut être récupéré par l'instruction sClapErreur décrite ci-dessous).
  
  
Ligne 30 : Ligne 30 :
 
<syntaxhighlight lang="windev">
 
<syntaxhighlight lang="windev">
 
//exemple pour le composant de mise-à-jour  
 
//exemple pour le composant de mise-à-jour  
gbMAJPossible est un booléen = plapMAJ.bComposantInit("bOGblequFmWXED3FkdSq1GisFOo67vzvo3ItRNBE","1RT12345SG597861")  //les codes indiqués sont à titre d'exemple et ne permettent pas d'exécuter le composant
+
gbMAJPossible est un booléen = plapMAJ.bClapInit("bOGblequFmWXED3FkdSq1GisFOo67vzvo3ItRNBE","1RT12345SG597861")  //les codes indiqués sont à titre d'exemple et ne permettent pas d'exécuter le composant
SI PAS gbMAJPossible ALORS Erreur(plapMAJ.sComposantErreur())
+
SI PAS gbMAJPossible ALORS Erreur(plapMAJ.sClapErreur())
 
</syntaxhighlight>
 
</syntaxhighlight>
  
  
 
;Remarque
 
;Remarque
Attention, tout composant peut fonctionner en mode "test" sans avoir appelé la fonction d'initialisation.  Si, malgré tout, vous souhaitez un logiciel clair, il n'est pas indispensable, '''pour ce mode test uniquement''', de passer en paramètre la clé et le numéro de transaction.  Si, néanmoins, vous en passez quand même en mode test, ils seront ignorés.  Exemple :
+
Attention, tous les composants proposés peuvent fonctionner en mode "test" sans appel à la fonction d'initialisation.  Si, néanmoins, vous souhaitez quand même mettre ce code en mode "test", la fonction clapInit n'exploitera pas les paramètres (vous pouvez mettre ce que vous y souhaitez).   
 +
Exemple :
 
<syntaxhighlight lang="windev">
 
<syntaxhighlight lang="windev">
SI PAS plapMAJ.bComposantInit() ALORS Erreur(plapMAJ.sComposantErreur())
+
SI PAS plapMAJ.bClapInit() ALORS Erreur(plapMAJ.sClapErreur())
 
</syntaxhighlight>
 
</syntaxhighlight>
 
  
 
== Fonction 'bComposantÉtat' ==
 
== Fonction 'bComposantÉtat' ==

Version du 3 février 2015 à 23:51

Tous les composants publiés par Lapalys permettent d'être testés dans l'environnement de développement WinDev. Il s'agit, dans ce cas, d'exécuter votre logiciel "en mode test" en cliquant sur le bouton GO. Vous pouvez alors évaluer les fonctions proposées sans aucune restriction.

Dès lors que votre logiciel est, lui-même, publié sous forme d'exécutable (par exemple), il est nécessaire d'enregistrer le composant chez Lapalys afin qu'il fonctionne dans ce mode. Pour faire cela, il vous suffit de vous rendre sur le site de Lapalys et de consulter la fiche du produit, en bas de laquelle vous trouverez les instructions pour votre enregistrement.

D'une manière générale, pour activer le composant dans votre logiciel, il suffit d'exécuter la fonction "bComposantInit" du composant (attention, chaque composant possède cette fonction et chaque composant doit être initialisé de la même manière). L'initialisation du composant ne doit se faire qu'une fois au démarrage de votre logiciel ou avant la première utilisation des fonctions du composant.

Fonction 'bClapInit'

Résumé
Initialise le composant avec la clé de licence. L'appel de cette méthode est optionnelle en mode test.


Syntaxe
[ <Résultat> = ] bClapInit (<sCléLicence> est chaîne [, <sTransactionPaypal> est chaîne])


Paramètres
sCléLicence (chaîne) : Clé de licence fournie par Lapalys (habituellement par courriel)
sTransactionPaypal (chaîne) : Numéro de transaction PayPal ayant servi à acheter la licence d'utilisation.


Valeur de retour

booléen :

vrai si le composant est bien initialisé, faux dans le cas contraire (message d'erreur peut être récupéré par l'instruction sClapErreur décrite ci-dessous).


Exemple

L'exemple suivant est extrait de l'initialisation du projet du composant de mise-à-jour. La variable gbMAJPossible sert alors dans les autres procédures pour exécuter leur code ... ou pas.

//exemple pour le composant de mise-à-jour 
gbMAJPossible est un booléen = plapMAJ.bClapInit("bOGblequFmWXED3FkdSq1GisFOo67vzvo3ItRNBE","1RT12345SG597861")  //les codes indiqués sont à titre d'exemple et ne permettent pas d'exécuter le composant
SI PAS gbMAJPossible ALORS Erreur(plapMAJ.sClapErreur())


Remarque

Attention, tous les composants proposés peuvent fonctionner en mode "test" sans appel à la fonction d'initialisation. Si, néanmoins, vous souhaitez quand même mettre ce code en mode "test", la fonction clapInit n'exploitera pas les paramètres (vous pouvez mettre ce que vous y souhaitez). Exemple :

SI PAS plapMAJ.bClapInit() ALORS Erreur(plapMAJ.sClapErreur())

Fonction 'bComposantÉtat'

Résumé
Donne l'état du composant.


Syntaxe
[ <Résultat> = ] bComposantEtat()


Paramètres
aucun


Valeur de retour

booléen :

vrai si le composant est bien initialisé, faux dans le cas contraire (message d'erreur peut être récupéré par l'instruction sComposantErreur décrite ci-dessous).


Exemple
//exemple pour le composant de mise-à-jour 
gbMAJPossible est un booléen = plapMAJ.bComposantEtat()
SI PAS gbMAJPossible ALORS Erreur(plapMAJ.sComposantErreur())


Fonction 'sComposantErreur'

Résumé
Retourne détail de l'erreur sous forme texte. Si l'erreur est vide et que bComposantEtat()=faux, c'est que le composant n'est pas exécuté en mode test et n'a pas encore été initialisé


Syntaxe
[ <Résultat> = ] sComposantErreur()


Paramètres
aucun


Valeur de retour

chaîne :

Détail de l'erreur sous forme texte


Exemple
//exemple pour le composant de mise-à-jour 
gbMAJPossible est un booléen = plapMAJ.bComposantEtat()
SI PAS gbMAJPossible ALORS Erreur(plapMAJ.sComposantErreur())