DataCommand.DeriveSchema, méthode (String, DataCommandType, array<IVsDataParameter , Int32)

Article
11/15/2012

Dérive le schéma retourné d'une commande spécifiée.Le schéma indique la disposition des éléments et des blocs dans un lecteur de données.

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

Syntaxe

'Déclaration
Public Overridable Function DeriveSchema ( _
    command As String, _
    commandType As DataCommandType, _
    parameters As IVsDataParameter(), _
    commandTimeout As Integer _
) As IVsDataReader

public virtual IVsDataReader DeriveSchema(
    string command,
    DataCommandType commandType,
    IVsDataParameter[] parameters,
    int commandTimeout
)

public:
virtual IVsDataReader^ DeriveSchema(
    String^ command, 
    DataCommandType commandType, 
    array<IVsDataParameter^>^ parameters, 
    int commandTimeout
)

abstract DeriveSchema : 
        command:string * 
        commandType:DataCommandType * 
        parameters:IVsDataParameter[] * 
        commandTimeout:int -> IVsDataReader 
override DeriveSchema : 
        command:string * 
        commandType:DataCommandType * 
        parameters:IVsDataParameter[] * 
        commandTimeout:int -> IVsDataReader

public function DeriveSchema(
    command : String, 
    commandType : DataCommandType, 
    parameters : IVsDataParameter[], 
    commandTimeout : int
) : IVsDataReader

Paramètres

command
Type : System.String
Une commande pour laquelle dérive le détail de schéma schéma à une source de données.

commandType
Type : Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType
Le type de la commande qui spécifie comment interpréter le contenu du paramètre d' command .Le type de commande peut être une valeur de l'énumération d' DataCommandType ou un type personnalisé de commande défini par un fournisseur, qui peut être passé en forçant un cast d'un entier à l'énumération d' DataCommandType .

parameters
Type : array<Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]
Un tableau d' IVsDataParameter objets représentant les paramètres de commande pour le type spécifié de commande.

commandTimeout
Type : System.Int32
La durée, en secondes, pour bloquer le client avant d'annuler la dérivation de schéma et retourner à l'appelant.Une valeur de 0 indique que la minuterie infinie ; une valeur de -1 indique une valeur par défaut de fournisseur.

Valeur de retour

Type : Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataReader
Objet IVsDataReader.Cet objet fournit un flux de données avant uniquement en lecture seule qui décrit la disposition des éléments et des blocs, c. autrement dit., le schéma, pour l'objet retourné lecteur en exécutant la commande spécifiée.

Implémentations

IVsDataCommand.DeriveSchema(String, DataCommandType, array<IVsDataParameter[], Int32)

Exceptions

Exception	Condition
ArgumentNullException	Le paramètre command est nullune référence null (Nothing en Visual Basic).
ArgumentOutOfRangeException	Le paramètre commandTimeout est inférieur à -1.

Notes

Le schéma du lecteur de données retourné par cette méthode doit suivre un format spécifique.Pour chaque résultat qui sera retourné lorsque vous exécutez la commande, il doit exister un résultat dans le lecteur de données.Chacun de ces résultats doit contenir les blocs qui décrivent les éléments qui sont retournés lorsque vous exécutez la commande.La description doit contenir les éléments suivants :

Nom (chaîne) : le nom de l'élément.
Ordinal (Int32) : la position de l'élément.
UserDataType (chaîne) : le type de données de l'élément (par exemple, « myType »).
NativeDataType (chaîne) : le type de données natif de l'élément (par exemple, « nvarchar »).
ProviderDataType (Int32) : le type de données du fournisseur de l'élément (par exemple, System.Data.SqlDbType.NVarChar).
ProviderDbType (Int32) : le type de données générique ADO.NET de l'élément (par exemple, System.Data.DbType.StringFixedLength).
FrameworkDataType (type) : le type de données d'infrastructure de l'élément (par exemple, System.Int32).
Longueur (Int32) : la longueur maximale de l'élément, le cas échéant.
Précision (Int32) : la précision de l'élément, le cas échéant.
Échelle (Int32) : l'échelle de l'élément, le cas échéant.
Nullable (Boolean) : le nullability de l'élément.

Ces éléments qu'un fournisseur ne prend pas en charge (par exemple, certaines formes de type de données) doivent être présent mais défini à nullune référence null (Nothing en Visual Basic).

[!REMARQUE]

D'autres exceptions qui se produisent indiquent que la dérivation de schéma a échoué pour une raison fournisseur- spécifiée.

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, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.