Sous-programmes et fonctions

Sous-routines et fonctions VBScript

Cette section présente une vue d'ensemble de l'utilisation des sous-routines et des procédures dans les scripts Visual Basic d'Altum Designer.

Passage de paramètres aux procédures

Lorsqu'une fonction ou une sous-routine (procédure/méthode) capable d'accepter des paramètres est définie dans un script, les variables peuvent être transmises à cette fonction ou sous-routine de deux manières : par référence ou par valeur, à l'aide de ByRef ou ByVal respectivement.

Pour déclarer la méthode à laquelle les paramètres sont transmis, utilisez le mot-clé ByRef ou ByVal dans la liste des paramètres lors de la définition de la fonction ou de la sous-routine dans un Sub ou Function . Par exemple, l'extrait de code suivant définit une sous-routine qui accepte deux paramètres. Le premier est transmis par valeur et le second par référence :

Sub Test (ByVal Param1 As Integer , ByRef B As String)

La différence entre ces deux méthodes réside dans le fait que ByRef transmet une référence à la variable et permet à la sous-routine ou à la fonction de modifier la variable réelle transmise en tant que paramètre. Il s’agit de la méthode par défaut de transmission des paramètres ; elle est utilisée si aucune méthode n’est explicitement déclarée.

ByVal ne transmet que la valeur de la variable. La sous-routine ou la fonction peut utiliser cette valeur, mais la variable d’origine transmise n’est pas modifiée.

Les exemples suivants illustrent les différences entre ces méthodes. La procédure principale est la suivante :

Sub Main
  Dim X, Y
  X = 45 : Y = "Number"
  Test X, Y   ' Call to a subprocedure called Test.
  MsgBox X
   MsgBox Y
End Sub

La procédure ci-dessus inclut un appel à une sous-procédure Test — voir ci-dessous.

Si la sous-routine est définie comme suit :

Sub Test (ByRef A, ByRef B)
  B = B & " = " & A : A = 10*A
End Sub

alors les variables X et Y dans la procédure principale sont référencées directement par la sous-routine. Il en résulte que les valeurs de X et Y sont modifiées par la sous-routine, de sorte qu’après l’ Test ; X = 450 et Y = « Number = 45 ». Il s’agit du comportement par défaut lorsque la méthode n’est pas explicitement déclarée.

Si, toutefois, la sous-routine est définie comme suit :

Sub Test (ByVal A, ByVal B)
B = B & " = " & A : A = 10*A
End Sub

alors, une fois Test a été exécutée, la procédure principale affiche : X = 45 et Y = « Number » — c'est-à-dire qu'elles restent inchangées.

Sinon, si la sous-routine est définie comme suit (méthodes mixtes) :

Sub Test (ByRef A, ByVal B)
  B = B & " = " & A : A = 10*A
End Sub

alors, après Test a été exécutée, X = 450 et Y = « Number », puisque Y a été passé par valeur, il reste inchangé.

Vous pouvez redéfinir le ByRef paramètre d’une fonction ou d’une sous-routine en plaçant le nom de la variable entre parenthèses dans l’instruction d’appel.

Appel de Test avec l’instruction suivante :

Test (X), Y

...transmettrait la variable X par valeur, quelle que soit la méthode définie pour ce paramètre dans la définition de la procédure.

Fonctions de date et d’heure

Le langage VBScript prend en charge un ensemble de routines de date et d'heure, comme indiqué ci-dessous :

Date

Day

Hour

IsDate

Minute

Month

Now

Second

Time

Year

 

 

Fonctions d'E/S de fichiers

Le langage VBScript prend en charge l'ensemble suivant de routines d'E/S de fichiers :

Dir

FileLen

FileTimeDate

FileCopy

Kill

Name

RmDir

MkDir

 

Routines mathématiques

Le langage VBScript prend en charge l'ensemble suivant de routines mathématiques :

Abs

Atn

Cos

Exp

Log

Not

Oct

Rnd

Sin

Sqn

Tan

 

Routines de chaînes de caractères

Le langage VBScript prend en charge toute une gamme de routines de chaînes de caractères, comme indiqué ci-dessous :

Asc

Chr

Format

InStr

InStrRev

LCase

Len

Left

Mid

Right

Str

Trim

LTrim

RTrim

UCase

Fonctions de processus serveur

Les routines de processus serveur sont utilisées lors de la gestion de processus dans les scripts, en particulier lorsqu'il est nécessaire d'extraire (récupérer) ou de définir des chaînes de caractères pour les paramètres du processus.

Pour exécuter des processus et définir des paramètres dans des scripts, utilisez les fonctions suivantes :

AddColorParameter

AddIntegerParameter

AddLongIntParameter

AddSingleParameter

AddWordParameter

GetIntegerParameter

GetStringParameter

ResetParameters

RunProcess

Useful functions

SetCursorBusy

ResetCursor

CheckActiveServer

GetActiveServerName

GetCurrentDocumentFileName

RunApplication

SaveCurrentDocument

 

 

Useful Dialogs

ConfirmNoYes

ConfirmNoYesCancel

ShowError

ShowInfo

ShowWarning

 

AI-LocalizedLocalisé par IA
Si vous trouvez un problème, sélectionnez le texte/l’image et appuyez surCtrl + Entréepour nous envoyer vos commentaires.
Disponibilité des fonctionnalités

Les fonctionnalités auxquelles vous avez accès dépendent de la solution Altium dont vous disposez – Altium Develop, Altium Agile Teams, Altium Agile Enterprise, ou Altium Designer (avec un abonnement actif).

Si vous ne voyez pas une fonctionnalité documentée dans votre logiciel actuel, contactez le service commercial d’Altium pour en savoir plus.

Documentation héritée

La documentation d’Altium Designer n’est plus versionnée. Si vous devez accéder à la documentation des versions antérieures d’Altium Designer, consultez la section Documentation héritée de la page Other Installers.

Contenu