ClapLog - Entrées et sorties

Détail des fonctions

Le composant renferme une collection de procédure. Aucune instanciation n'est donc nécessaire. Il est toutefois indispensable d'initialiser le composant (bComposantInit) et les fonctions de Log (en utilisant bLogInit()).

Seules les fonctions spécifiques sont ici décrites. Pour les fonctions standard surchargées, veuillez vous reporter à la documentation officielle.

Fonctions surchargées

• iImprimeEtat
• iFinImprime

Fonction 'bLogInit'

Résumé

Initialise les fonctions de log du composant (doit être placé dans l'initialisation du projet). Pour ne pas compresser le fichier de destination, mettre la valeur vide "" dans le paramètre sExtensionArchiveLog de la fonction bLogInit(). Pour spécifier un numéro de port pour le serveur SMTP, mettez dans le paramètre sServeurSMTP le nom du serveur + ":" + le numéro de port (exemple smtp.free.fr:25).

Syntaxe

bLogInit (<sRepertoireLog> est chaîne [, <sNomUsager> est chaîne [, <sExtensionArchiveLog> est chaîne [, <sServeurSMTP> est chaîne [, <sCompteSMTP> est chaîne, [, <sPasseSMTP> est chaîne [, <sExpéditeurCourriel> est chaîne [, <sDestinataireCourriel> est chaîne]]]])

Paramètres

sRepertoireLog(chaîne) : répertoire dans lequel les fichiers de Log seront déplacés ultimement;

sNomUsager(chaîne - valeur par défaut=vide) : Nom de l'utilisateur du programme (qui contient ce composant). Ce nom fera partie du nom de fichier de Log : Log_NomUsager_NumProcessusDuProgramme_DateHeure (voir ClapLog - Utilisation chapitre "Gestion du fichier de sortie". Si ce paramètre est vide, il sera remplacé par la variable d'environnement COMPUTERNAME. Si ce dernier est également vide, le nom d'usager sera mis à "DefaultLogUser";

sExtensionArchiveLog(chaîne - valeur par défaut="ZIP") : Extension de l'archive à créer quand le fichier de Log est envoyé vers sa destination. Valeur reconnues : ZIP, CAB, WDZ;

sServeurSMTP(chaîne - valeur par défaut=vide) : Nom du serveur SMTP pour l'envoi d'erreur (lors de la gestion du fichier de Log). Si ce paramètre est vide, l'envoi de courriel sera désactivé;

sCompteSMTP(chaîne - valeur par défaut=vide) : Nom du compte à utiliser sur le serveur SMTP pour ouvrir une session;

sPasseSMTP(chaîne - valeur par défaut=vide) : Mot de passe du compte à utiliser sur le serveur SMTP pour ouvrir une session;

sExpéditeurCourriel(chaîne - valeur par défaut=vide) : Adresse courriel de l'expéditeur du courriel d'erreur (nom@domaine.com);

sDestinataireCourriel(chaîne - valeur par défaut=vide) : Adresse courriel du destinataire du courriel d'erreur (nom@domaine.com).

Valeur de retour

booléen : vrai si tous les paramètres passés à la fonction sont corrects, faux dans le cas contraire (voir le message d'erreur dans la fonction sComposantErreur());

Exemple

//Le répertoire est mis sur le réseau local et le nom d'usager est repris du groupware utilisateur WinDev
SI PAS bLogInit("F:\Users\Log",gpwRecupInfoUtilisateur(gpwInfoLogin)) ALORS
	Erreur("Erreur durant l'initialisation du Log : ",sComposantErreur())
FIN

Remarque

Il est possible que cette fonction renvoie vrai mais qu'il existe un message dans sComposantErreur(). Ce message est un avertissement, n'empêchant pas le composant de fonctionner mais limitant ses fonctionnalités.

Fonction 'LogTermine'

Résumé

Fonction qui doit être appelée à la fin de projet (doit être appelé à la fermeture du projet). Permet de déplacer le fichier de Log du répertoire temporaire de Windows vers le répertoire de destination spécifié dans la fonction bLogInit(). Cette fonction se charge aussi de compresser, le cas échéant, le fichier CSV en fichier compressé (ZIP, CAB, WDZ selon le paramétrage de bLogInit()) avant l'envoi dans son répertoire de destination. Le nom de l'archive utilisé dans le composant est "clapLogArchive".

Syntaxe

LogTermine()

Paramètres

Aucun

Valeur de retour

Aucune

Exemple

LogTermine()		//à mettre en fin de projet ou de la fenêtre principale

Fonction 'LogDébut'

Résumé

Permet de débuter un chronomètre pour identifier le temps de traitement d'un bout de code.

Syntaxe

LogCommence([<sMessage> est chaîne])

Paramètres

sMessage(chaîne - valeur par défaut=vide) : message particulier à faire apparaître dans le fichier de Log.

Valeur de retour

entier : Identifiant unique

Exemple

nID est un entier LogDebut("Début de mon code")

// ... ici la première partie de votre code (boucle, requête, traitement long)

LogEtape(nID,"fin de l'étape 1")

// ... ici la seconde partie de votre code (boucle, requête, traitement long)

LogFin(nID,"Fin de mon code")

Fonction 'LogFin'

Résumé

Permet d'arrêter un chronomètre créé par la fonction LogDébut. Il est nécessaire que le chronomètre soit démarré par la fonction LogDébut().

Syntaxe

LogFin(<nIDChrono> est entier, [<sMessage> est chaîne])

Paramètres

nIDChrono(entier) : valeur entière retournée par la fonction LogDébut().

sMessage(chaîne - valeur par défaut=vide) : message particulier à faire apparaître dans le fichier de Log.

Valeur de retour

Aucune

Exemple

voir fonction LogDébut

Fonction 'LogÉtape'

Résumé

Permet d'ajouter une ligne intermédiaire dans le fichier Log. Il est nécessaire que le chronomètre soit démarré par la fonction LogDébut().

Syntaxe

LogÉtape(<nIDChrono> est entier, [<sMessage> est chaîne])

Paramètres

nIDChrono(entier) : valeur entière retournée par la fonction LogDébut().

sMessage(chaîne - valeur par défaut=vide) : message particulier à faire apparaître dans le fichier de Log.

Valeur de retour

Aucune

Exemple

voir fonction LogDébut

Fonction 'sLogNomFichier'

Résumé

Renvoie le nom du fichier Log créé dans le répertoire temporaire de Windows.

Syntaxe

sLogNomFichier()

Paramètres

Aucun

Valeur de retour

chaîne : Nom du fichier Log créé dans le répertoire temporaire de Windows

Exemple

Info(sLogNomFichier())

Fonction 'bLogTestCourrielErreur'

Résumé

Teste si les paramètres SMTP sont corrects pour l'envoi d'un message d'erreur (au cas où la création ou l'envoi d'un fichier de Log tombe en erreur). En cas d'erreur, le message est mis dans le fichier de Log.

Syntaxe

bLogTestCourrielErreur()

Paramètres

Aucun

Valeur de retour

booléen : vrai si le courriel s'est bien envoyé, faux dans le cas contraire;

Exemple

SI PAS bLogTestCourrielErreur() ALORS
	Erreur("Le courriel de test n'a pas pu être envoyé !")
FIN

Dysfonctionnements, commentaires et suggestions

Merci de contacter notre support. Vous trouverez nos coordonnées et les conditions bas de notre site internet.

Liens utiles

Utilisation du composant

Téléchargement et licence