DataCommand.DeriveSchema, méthode

Article
11/15/2012

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

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

Syntaxe

'Déclaration
Public Overridable Function DeriveSchema ( _
    command As String, _
    commandType As Integer, _
    parameters As DataParameter(), _
    commandTimeout As Integer _
) As DataReader

public virtual DataReader DeriveSchema(
    string command,
    int commandType,
    DataParameter[] parameters,
    int commandTimeout
)

public:
virtual DataReader^ DeriveSchema(
    String^ command, 
    int commandType, 
    array<DataParameter^>^ parameters, 
    int commandTimeout
)

abstract DeriveSchema : 
        command:string * 
        commandType:int * 
        parameters:DataParameter[] * 
        commandTimeout:int -> DataReader 
override DeriveSchema : 
        command:string * 
        commandType:int * 
        parameters:DataParameter[] * 
        commandTimeout:int -> DataReader

public function DeriveSchema(
    command : String, 
    commandType : int, 
    parameters : DataParameter[], 
    commandTimeout : int
) : DataReader

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 : System.Int32
Le type de commande pour l'ordre indiqué, spécifiant comment interpréter le contenu du paramètre d' command .

parameters
Type : array<Microsoft.VisualStudio.Data.DataParameter[]
Un tableau d'objets DataParameter pour le type spécifié de commande.Lorsque c'est un paramètre d'entrée, le fournisseur de DDEX peut encore définir des propriétés sur la personne et les paramètres de valeur de retour.Toutefois, ils ne sont pas remplis en dérivant le schéma.

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 le délai d'attente infini ; une valeur de -1 indique une valeur par défaut de fournisseur.

Valeur de retour

Type : Microsoft.VisualStudio.Data.DataReader
Retourne un objet DataReader.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.

Exceptions

Exception	Condition
ArgumentNullException	La commande ou les asyncCommandEvents sont null.
ArgumentException	Le commandType spécifie un type non valide.
ArgumentOutOfRangeException	Le commandTimeout est inférieure à -1.
NotSupportedException	Le fournisseur ne prend pas en charge cette méthode.

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 est retourné en exécutant 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 seraient retournés en exécutant 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.DbType.StringFixedLength).
FrameworkDataType (type) : le type de données d'infrastructure de l'élément (par exemple, System.Int32).
Longueur (Int32) : la longueur maximale d'un élément, le cas échéant.
Précision (Int32) : la précision d'un élément, le cas échéant.
Échelle (Int32) : l'échelle d'un élément, le cas échéant.
Nullable (Boolean) : le nullability d'un é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 paramètre 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.

Voir aussi

Référence

DataCommand Classe

Microsoft.VisualStudio.Data, espace de noms

DataReader

Partager via