IVsDataProvider.GetProperty, méthode

Article
05/16/2015

Obtient une propriété inscrite du fournisseur de DDEX.

Espace de noms : Microsoft.VisualStudio.Data.Core
Assembly : Microsoft.VisualStudio.Data.Core (dans Microsoft.VisualStudio.Data.Core.dll)

Syntaxe

'Déclaration
Function GetProperty ( _
    name As String _
) As Object

Object GetProperty(
    string name
)

Object^ GetProperty(
    String^ name
)

abstract GetProperty : 
        name:string -> Object

function GetProperty(
    name : String
) : Object

Paramètres

name
Type : String

Nom de la propriété à récupérer.

Valeur de retour

Type : Object
La valeur de propriété, si existe ; sinon, nullune référence null (Nothing en Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	Le paramètre name est nullune référence null (Nothing en Visual Basic).

Notes

Un fournisseur de DDEX peut stocker un ensemble de propriétés que les clients de DDEX peuvent accéder pour déterminer des informations sur le fournisseur. Les propriétés standard incluent le nom du fournisseur, le nom complet, le nom complet court, la description, et la technologie, mais toute propriété peut être incluse par le fournisseur.

Une valeur de propriété est récupérée en ouvrant la clé de Registre de la racine du fournisseur de DDEX et en demandant une valeur sous la clé portant le nom spécifié. (La clé de Registre de la racine se trouve sous la clé de DataProviders dans la ruche locale de Registre Visual Studio.) Une fois qu'une propriété spécifique a été demandée, sa valeur est stockée en mémoire par le runtime de DDEX et pas actualisées jusqu'à ce que Visual Studio redémarré.

Exemples

Le code suivant montre comment récupérer la valeur de la propriété InvariantName, généralement définie par les fournisseurs de DDEX basés sur la technologie ADO.NET. La valeur de cette propriété est ensuite utilisée pour créer un objet de connexion ADO.NET via les API de DbProviderFactory.

using System;
using System.Data;
using System.Data.Common;
using Microsoft.VisualStudio.Data.Core;

public class DDEX_IVsDataProviderExample4
{
    public static DbConnection CreateAdoDotNetConnection(
        IVsDataProvider provider)
    {
        string invariantName = provider.GetProperty("InvariantName") as string;
        if (invariantName != null)
        {
            DbProviderFactory factory = DbProviderFactories.GetFactory(
                invariantName);
            if (factory != null)
            {
                return factory.CreateConnection();
            }
        }
        return null;
    }
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

IVsDataProvider Interface

Microsoft.VisualStudio.Data.Core, espace de noms

Partager via