Méthodes de connecteur KeyValuePair

Les méthodes de connecteur de paire de valeurs clés permettent d’effectuer diverses actions sur les paires de valeurs clés. Dans un flux d’automatisation, les méthodes sont connectées à d’autres méthodes et composants. Pour utiliser les méthodes, vous devez d’abord les exposer.

Ajouter

Ajoute une paire keyvalue.

Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

Tableau 1. Ajouter des paramètres de méthode

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Clé	Nom de la clé.	Données dans	Chaîne	Néant	Oui
Valeur	Valeur de la clé.	Données dans	Objet	Néant	Oui
Ignorer les doublons	Si la valeur est Vrai, la méthode ignore les doublons. Sinon, si la valeur est False, la méthode renvoie un message d’erreur.	Données dans	Booléen	Néant	Non

Effacer

Efface toutes les paires de valeurs clés.

Contientune clé

Renvoie la valeur Vrai si la clé spécifiée existe, sinon renvoie la valeur Faux.

Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

Tableau 2. ContientParamètres de méthode clé

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Clé	Nom de la clé.	Données dans	Chaîne	Néant	Oui
Retour	Renvoie la valeur Vrai si la clé spécifiée existe, sinon renvoie la valeur Faux.	Sortie de données	Booléen	Non applicable	Non applicable

ContientValeur

Renvoie la valeur Vrai si la valeur de clé spécifiée existe, sinon renvoie la valeur Faux.

Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

Tableau 3. Paramètres de méthode ContainsValue

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Valeur	Nom de la valeur de clé.	Données dans	Chaîne	Néant	Oui
Retour	Renvoie la valeur Vrai si la valeur de clé spécifiée existe, sinon renvoie la valeur Faux.	Sortie de données	Booléen	Non applicable	Non applicable

Nombre

Renvoie le nombre total de paires clé-valeur.

Tableau 4. Paramètres de la méthode de comptage

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Retour	Renvoie le nombre total de paires clé-valeur.	Sortie de données	Entier	Non applicable	Non applicable

Supprimer

Supprime la clé spécifiée.

Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

Tableau 5. Supprimer les paramètres de méthode

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Clé	Nom de la clé.	Données dans	Chaîne	Néant	Oui

Obtenir l’élément

Renvoie la valeur de la clé spécifiée.

Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

Tableau 6. Paramètres de méthode GetItem

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Clé	Nom de la clé.	Données dans	Chaîne	Néant	Oui
Retour	Renvoie la valeur de la clé.	Sortie de données	Objet	Non applicable	Non applicable

GetItems

Renvoie les valeurs de plusieurs clés. Vous devez d’abord configurer les clés dans la méthode.

Pour configurer, procédez comme suit.

1. Cliquez sur l’icône Paramètres de méthode ( ).
2. Cliquez sur l’icône Ajouter des touches (icône
3. Entrez le nom de la clé.
4. Mettez à jour le type de données clé à partir de la liste.
5. Répétez les étapes pour définir plusieurs noms de clés.
6. Cliquez sur OK.

   Un port de sortie de données est créé avec chaque nom de clé que vous définissez.

Tableau 7. Paramètres de méthode GetItems

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Clé	Renvoie la valeur de la clé.	Sortie de données	Objet	Non applicable	Non applicable

GetItemsByIndex

Renvoie les valeurs de clé en fonction de leur index. Vous devez d’abord configurer les index dans la méthode.

Pour configurer, procédez comme suit.

1. Cliquez sur l’icône Paramètres de méthode ( ).
2. Cliquez sur l’icône Ajouter des index (icône
3. Entrez l’index de clé.
4. Mettez à jour le type de données clé à partir de la liste.
5. Répétez les étapes pour définir plusieurs index de clés.
6. Cliquez sur OK.

   Un port de sortie de données est créé avec chaque index de clé que vous définissez.

Tableau 8. Paramètres de méthode GetItemsByIndex

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Index de clé	Renvoie la valeur de la clé.	Sortie de données	Objet	Non applicable	Non applicable

ParseFromText

Analyse le texte spécifié en paires de valeurs clés. Il peut créer plusieurs paires clé-valeur.

Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

Tableau 9. Paramètres de la méthode ParseFromText

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Texte	Texte comprenant les clés et les valeurs analysées par la méthode.	Données dans	Chaîne	Néant	Oui
ItemSeparator	Séparateur entre deux paires de valeurs clés.	Données dans	Chaîne	Néant	Oui
Séparateur de valeur de clé	Séparateur entre la clé et sa valeur.	Données dans	Chaîne	Néant	Oui
ClearBeforeParse	Si la valeur est Vrai, efface toute paire de valeurs de clé existante avant l’analyse.	Données dans	Booléen	Néant	Non

Inverser

Inverse les index clés.

Conseil :

Après avoir exécuté la méthode, vous pouvez voir la sortie en exécutant la méthode GetItemsByIndex.

SetData (en anglais)

Besoin d’informations.

SetItem

Met à jour la valeur d’une clé.

Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

Tableau 10. Paramètres de la méthode SetItem

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Clé	Nom de la clé.	Données dans	Chaîne	Néant	Oui
Valeur	Valeur mise à jour de la clé.	Données dans	Objet	Néant	Oui

Conseil :

Testez la valeur mise à jour en exécutant la méthode GetItemsByIndex.

SetItems

Met à jour les valeurs des clés spécifiées. Vous devez d’abord configurer les clés dans la méthode.

Pour configurer les clés, procédez comme suit.

1. Cliquez sur l’icône Paramètres de méthode ( ).
2. Cliquez sur l’icône Ajouter des touches (icône
3. Entrez le nom de la clé.
4. Mettez à jour le type de données clé à partir de la liste.
5. Répétez les étapes pour définir plusieurs noms de clés.
6. Cliquez sur OK.

   Un port de données est créé avec chaque nom de clé que vous définissez.

Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

Tableau 11. Paramètres de méthode SetItems

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Clé	Valeur mise à jour de la clé.	Données dans	Objet	Néant	Oui

Conseil :

Testez la valeur mise à jour en exécutant la méthode GetItemsByIndex.

SetItemsByIndex

Met à jour les valeurs des clés en fonction des index spécifiés. Vous devez d’abord configurer les index dans la méthode.

Pour configurer les index, procédez comme suit.

1. Cliquez sur l’icône Paramètres de méthode ( ).
2. Cliquez sur l’icône Ajouter des index (icône
3. Entrez l’index de clé.
4. Mettez à jour le type de données clé à partir de la liste.
5. Répétez les étapes pour définir plusieurs index de clés.
6. Cliquez sur OK.

   Un port de données est créé avec chaque index de clé que vous définissez.

Tableau 12. Paramètres de méthode SetItemsByIndex

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
Index de clé	Index de la clé.	Données dans	Objet	Néant	Oui

Conseil :

Testez la valeur mise à jour en exécutant la méthode GetItemsByIndex.

ToJSON

Affiche les paires clé-valeur au format JSON.

Texte cible

Affiche les paires clé-valeur au format texte.

Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

Tableau 13. Paramètres de la méthode ToText

Paramètre	Description	Type de port de données	Type de données	Valeur par défaut	Obligatoire ?
ValeursOnly	Si la valeur est True, la méthode affiche uniquement les valeurs des clés, sinon affiche la paire keyvalue.	Données dans	Booléen	Néant	Non
Retour	Renvoie la paire keyvalue au format texte.	Sortie de données	Chaîne	Non applicable	Non applicable