CasewareDocumentation
Nouveautés de Caseware Cloud EngagementsVoir les nouveautés

Paramètres

Renvoie une collection de paramètres d'exécution du test d'audit.

Compatibilité

Proposé dès IDEA version 12.0

Syntaxe

Parameters As Collection

Valeur retournée

Collection énumérable de paramètres d'exécution logiques du test d'audit.

Remarques

Un élément de collection (paramètre d'exécution) met en œuvre les propriétés suivantes :

Propriétés
Méthode Type de données Description
Id String Obtient le nom symbolique (identifiant) du paramètre.
ParameterType Integer

Obtient le type de paramètre. Le type peut être :

Inconnu = 0

Aging = 1

CheckBox = 2

ComboBox = 3

Duplicate = 4

FromToList = 5

Gap = 6

OptionGroup = 7

SingleList = 8

Stratification = 9

TextBox = 10

Weekend = 11

ParameterDataType Integer

Obtient le type de données du paramètre. Le type de données peut être :

Inconnu = 0

Numérique = 1

Décimal = 2

Chaîne = 3

Date = 4

Heure = 5

DisplayName String Obtient un nom lisible par l'humain du paramètre.
Valeur Object Obtient ou définit la valeur du paramètre. La valeur du paramètre logique est toujours vide.

La collection de paramètres est énumérable, c.-à-d. qu'elle peut être utilisée POUR CHAQUE boucle. En plus, elle met en œuvre les propriétés ou méthodes suivantes :

Propriété/méthodes
Méthode Type de données Description
Décompte Integer Obtient le nombre d'éléments dans la collection.
Get(id As String) Object

Renvoie le paramètre d'exécution ayant l'identifiant indiqué. Si ce paramètre n'existe pas, rien n'est renvoyé.

Item(index As Integer) Object

Renvoie le paramètre d'exécution par son index dans la collection. L'index est basé sur zéro.

Exemple

Sub Main()
Dim ac As Object
Dim at As Object
Set ac = CreateObject("SmartAnalyzer.AutomationClient")
Set at = ac.GetAT("f4d65220-77f1-5969-8943-59c7bd448460")
Set params = at.Parameters
' obtaining parameters’ count
MsgBox"Parameters' count: " & params.Count
' obtaining parameter by its index
id0 = params.Item(0).Id
' obtaining parameter by its id (symbolic name)
Set par0 = params.Get(id0)
MsgBox"Name of the first parameter: '" + id0 + "'"
MsgBox "Display name of '" + id0 + "' parameter: '" + par0.DisplayName + "'"
' enumerating parameters’ collection
FOR EACH p IN params
MsgBox "Next param: name = '" & p.Id & "', type = " & p.ParameterType &_
", data type = " & p.ParameterDataType &_
", display name = '" & p.DisplayName & "'"
NEXT
End Sub

Lorsqu'il est exécuté, ce script produit la séquence de sortie suivante :

Décompte des paramètres : 3

Nom du premier paramètre : « smartCheckBox2 »

Afficher le nom du paramètre « smartCheckBox2 » : « Trouver des commentaires vides »

Next param: name = 'smartCheckBox2', type = 2, data type = 1, display name = 'Trouver des commentaires vides'

Next param: name = 'smartSingleList1', type = 8, data type = 3, display name = 'Rechercher'

Next param: name = 'smartCheckBox1', type = 2, data type = 1, display name = 'Activer la sensibilité à la casse pour la recherche'