DataRecordsets.AddFromConnectionFile, méthode (Visio)

Article
04/07/2023

Ajoute un objet DataRecordset à la collection DataRecordsets en utilisant les informations de connexion et de requête contenues dans un fichier ODC (Office Data Connection) pour se connecter à une source de données OLEDB ou ODBC et récupérer des données à partir d’une source de données OLEDB ou ODBC.

Remarque

Cet objet ou ce membre Visio est disponible uniquement pour les titulaires d’une licence d’utilisation de Visio Professionnel 2013.

Syntaxe

expression. AddFromConnectionFile (FileName, AddOptions, Name)

Expression Expression qui renvoie un objet DataRecordsets .

Parameters

Nom	Requis/Facultatif	Type de données	Description
FileName	Obligatoire	String	Nom du fichier de connexion ODC à utiliser.
AddOptions	Obligatoire	Long	Options qui déterminent les propriétés du jeu d’enregistrements de données à ajouter. Combinaison d’une ou de plusieurs valeurs énumérées de VisDataRecordsetAddOptions. Pour plus d’informations, consultez la rubrique Remarques.
Name	Facultatif	String	Attribue un nom complet à l'objet DataRecordset ajouté.

Valeur renvoyée

DataRecordset

Remarques

Pour le paramètre NomFichier, passez le nom et le chemin d'accès complet au fichier ODC qui contient la chaîne de connexion qui spécifie comment se connecter à une source de données OLEDB ou ODBC et une chaîne de requête qui spécifie comment extraire les données voulues de la source de données.

Un fichier ODC utilise le langage HTML et XML pour stocker des informations de connexion et de requête. Le contenu de ce fichier peut être édité dans n’importe quel éditeur de texte. Les fichiers ODC portent l’extension .odc. Utilisez l’Assistant Connexion de données dans Microsoft Access ou Microsoft Excel pour créer un fichier ODC qui se connectera à et récupérera les données souhaitées.

Le paramètre AjouterOptions peut être une combinaison d’une ou plusieurs des valeurs issues de l'énumération VisDataRecordsetAddOptions, qui est déclarée dans la bibliothèque de types de Visio. La valeur par défaut est zéro (0) et spécifie qu'aucune option n'est définie.

Constante	Valeur	Description
visDataRecordsetNoExternalDataUI	1	Empêche les données du nouveau jeu d'enregistrements de données d'être affichées dans la fenêtre Données externes.
visDataRecordsetNoRefreshUI	2	Empêche l'intégration du jeu d'enregistrements de données dans l'opération d'actualisation et son affichage dans la boîte de dialogue Actualiser les données.
visDataRecordsetNoAdvConfig	4	Empêche l'affichage du jeu d'enregistrements de données dans la fenêtre Configurer l'actualisation.
visDataRecordsetDelayQuery	8	Ajoute un jeu d'enregistrements de données mais n'exécute pas la requête ChaîneCommande tant que la méthode Refresh n'est pas appelée.
visDataRecordsetDontCopyLinks	16	Ajoute un jeu d’enregistrements de données, mais les liaisons de données de forme ne sont ni coupées ni copiées.

Une fois ces valeurs attribuées, vous ne pouvez pas les modifier pour l'objet DataRecordset.

L'argument Nom est une chaîne facultative qui permet d'attribuer un nom complet au jeu d'enregistrement de données. Si vous demandez l'affichage de la fenêtre Données externes dans l'interface de Visio, le nom passé pour cet argument apparaît sous l'onglet de la fenêtre Données externes qui correspond au jeu d'enregistrement de données que vous avez ajouté.

Si la méthode AddFromConnectionFile réussit, elle effectue les actions suivantes :

Crée un objet DataRecordset et lui attribue le nom défini dans le paramètre Nom. Si vous ne spécifiez pas de nom, Visio attribue au jeu d’enregistrements de données le nom de la table de base de données qui est la source des données.
Associe un nouvel objet DataConnection existant à l'objet DataRecordset.
Exécute la chaîne de requête spécifiée dans la chaîne de commande dans le fichier ODC et récupère les données obtenues.
Mappe les types de données des colonnes de la source de données aux types de données équivalents dans Visio, tout en filtrant les résultats pour supprimer les colonnes de la source de données qui ne peuvent pas être liées aux formes Visio car elles ne possèdent aucun type de données équivalent dans Visio.
Attribue un ID de ligne à chaque ligne du jeu d’enregistrements de données. Pour plus d’informations sur les ID de ligne, consultez la rubrique de propriété DataRecordset.GetDataRowIDs .

Remarque

La méthode AddFromConnectionFile échoue et renvoie une exception si elle rencontre des erreurs liées à la connexion réseau, à des délais d'attente réseau ou à des autorisations de base de données.

Exemple

La macro Microsoft Visual Basic pour Applications (VBA) suivante montre comment utiliser la méthode AddFromConnectionString pour connecter un dessin Visio afin de vous connecter aux données de la table Products de la base de données Northwind fournie avec Microsoft Access. Avant d’exécuter cet exemple de code, utilisez l’Assistant Connexion de données pour créer un fichier ODC et remplacez la valeur de la variable strFile par le chemin d’accès complet et le nom de fichier du fichier ODC que vous avez créé. Si vous le souhaitez, fournissez une valeur différente pour la variable strName .

Public Sub AddFromConnectionFile_Example() 
 
    Dim strFile As String 
    Dim strName As String 
    Dim vsoDataRecordset As Visio.DataRecordset 
 
    strFile = "C:\Users\username \Documents\My Data Sources\Northwind.mdb Products.odc" 
 
    strName = "Data from ODC" 
 
    Set vsoDataRecordset = ThisDocument.DataRecordsets.AddFromConnectionFile(strFile, 0, strName) 
 
End Sub

Assistance et commentaires

Avez-vous des questions ou des commentaires sur Office VBA ou sur cette documentation ? Consultez la rubrique concernant l’assistance pour Office VBA et l’envoi de commentaires afin d’obtenir des instructions pour recevoir une assistance et envoyer vos commentaires.