DataCommand, classe
Fournit la possibilité de générer et exécuter des commandes de données de différents types pour les sources de données, et de récupérer des résultats en lecture seule ou code d'état de commande.
Hiérarchie d'héritage
Object
Microsoft.VisualStudio.Data.Framework.DataSiteableObject<IVsDataConnection>
Microsoft.VisualStudio.Data.Framework.DataCommand
Espace de noms : Microsoft.VisualStudio.Data.Framework
Assembly : Microsoft.VisualStudio.Data.Framework (dans Microsoft.VisualStudio.Data.Framework.dll)
Syntaxe
'Déclaration
Public MustInherit Class DataCommand _
Inherits DataSiteableObject(Of IVsDataConnection) _
Implements IVsDataCommand
public abstract class DataCommand : DataSiteableObject<IVsDataConnection>,
IVsDataCommand
public ref class DataCommand abstract : public DataSiteableObject<IVsDataConnection^>,
IVsDataCommand
[<AbstractClass>]
type DataCommand =
class
inherit DataSiteableObject<IVsDataConnection>
interface IVsDataCommand
end
public abstract class DataCommand extends DataSiteableObject<IVsDataConnection> implements IVsDataCommand
Le type DataCommand expose les membres suivants.
Constructeurs
| Nom | Description | |
|---|---|---|
.gif "Méthode protégée") |
DataCommand() | Initialise une nouvelle instance de la classe DataCommand. |
|
DataCommand(IVsDataConnection) | Initialise une nouvelle instance de la classe DataCommand avec un objet de connexion de données. |
Début
Propriétés
| Nom | Description | |
|---|---|---|
.gif "Propriété publique") |
Site | Obtient ou définit le site d'objet. (Hérité de DataSiteableObject<T>.) |
Début
Méthodes
| Nom | Description | |
|---|---|---|
.gif "Méthode publique") |
CreateParameter | Crée un objet paramètre qui peut être passé dans les méthodes DeriveSchema, DeriveSchema, Execute, ou ExecuteWithoutResults sur une instance de DataCommand. |
|
DeriveParameters(String) | Dérive les paramètres pouvant être spécifiés pour une commande donnée. |
|
DeriveParameters(String, DataCommandType) | Dérive les paramètres pouvant être spécifiés pour une commande donnée. |
|
DeriveParameters(String, DataCommandType, Int32) | Dérive les paramètres pouvant être spécifiés pour une commande donnée. |
|
DeriveSchema(String) | Dérive le schéma retourné d'une commande spécifiée.Le schéma affiche la disposition des éléments et des blocs à un lecteur de données. |
|
DeriveSchema(String, DataCommandType) | Dérive le schéma retourné d'une commande spécifiée.Le schéma affiche la disposition des éléments et des blocs à un lecteur de données. |
|
DeriveSchema(String, DataCommandType, array<IVsDataParameter[]) | Dérive le schéma retourné d'une commande spécifiée.Le schéma affiche la disposition des éléments et des blocs à un lecteur de données. |
|
DeriveSchema(String, DataCommandType, array<IVsDataParameter[], Int32) | Dérive le schéma retourné d'une commande spécifiée.Le schéma affiche la disposition des éléments et des blocs à un lecteur de données. |
|
Equals | Détermine si l'objet spécifié est identique à l'objet actuel. (Hérité de Object.) |
|
Execute(String) | Exécute une commande spécifiée et retourne des résultats en lecture seule. |
|
Execute(String, DataCommandType) | Exécute une commande spécifiée et retourne des résultats en lecture seule. |
|
Execute(String, DataCommandType, array<IVsDataParameter[]) | Exécute une commande spécifiée, éventuellement avec des paramètres, et les résultats en lecture seule de retour. |
|
Execute(String, DataCommandType, array<IVsDataParameter[], Int32) | Exécute une commande spécifiée, éventuellement avec des paramètres, et les résultats en lecture seule de retour. |
|
ExecuteWithoutResults(String) | Exécute une commande mais ne demande pas de résultats, en revanche retournant un entier indiquant les résultats de l'appel. |
|
ExecuteWithoutResults(String, DataCommandType) | Exécute une commande mais ne demande pas de résultats, en revanche retournant un entier indiquant les résultats de l'appel. |
|
ExecuteWithoutResults(String, DataCommandType, array<IVsDataParameter[]) | Exécute une commande, éventuellement avec des paramètres, mais ne demande pas de résultats, en revanche retournant un entier indiquant les résultats de l'appel. |
|
ExecuteWithoutResults(String, DataCommandType, array<IVsDataParameter[], Int32) | Exécute une commande, éventuellement avec des paramètres, mais ne demande pas de résultats, en revanche retournant un entier indiquant les résultats de l'appel. |
|
Finalize | Autorise un objet à tenter de libérer des ressources et à exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par une opération garbage collection. (Hérité de Object.) |
|
GetHashCode | Sert de fonction de hachage par défaut. (Hérité de Object.) |
|
GetType | Obtient le Type de l'instance actuelle. (Hérité de Object.) |
|
MemberwiseClone | Crée une copie superficielle du Object actuel. (Hérité de Object.) |
|
OnSiteChanged | Déclenche l'événement SiteChanged. (Hérité de DataSiteableObject<T>.) |
|
Prepare(String) | Prépare la commande spécifiée dans la source de données à exécuter ; la commande peut ensuite s'exécuter plusieurs fois, dans des paramètres. |
|
Prepare(String, DataCommandType) | Prépare la commande spécifiée dans la source de données à exécuter ; la commande peut ensuite s'exécuter plusieurs fois, dans des paramètres. |
|
Prepare(String, DataCommandType, array<IVsDataParameter[]) | Prépare la commande spécifiée dans la source de données à exécuter ; la commande peut ensuite s'exécuter plusieurs fois, dans des paramètres. |
|
Prepare(String, DataCommandType, array<IVsDataParameter[], Int32) | Prépare la commande spécifiée dans la source de données à exécuter ; la commande peut ensuite s'exécuter plusieurs fois, dans des paramètres. |
|
ToString | Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.) |
Début
Événements
| Nom | Description | |
|---|---|---|
.gif "Événement public") |
SiteChanged | Se produit lorsque la propriété Site est modifiée. (Hérité de DataSiteableObject<T>.) |
Début
Notes
Les fournisseurs concepteurs de Extensibility Framework (DDEX) de données peuvent exécuter divers types de commandes sur une source de données. Cela ne peut comprendre, mais être seulement, des instructions SQL, des procédures, des appels de fonction. Ils peuvent également exposer la capacité de préparer et dériver des paramètres et les schémas des commandes.
La classe DataCommand présente les types de commande. Type de commande affiche une translation de programmation d'une chaîne de commande donnée. Par exemple, un texte du type de commande peut informer le fournisseur de DDEX que la chaîne de commande est une instruction SQL qui doivent être exécutées directement. En outre, un type d'ordre de TabularFunction peut informer le fournisseur de DDEX que la chaîne de commande est le nom d'une fonction table qui doit être effectuée à l'aide de la méthode appropriée.
Technologies sous-jacentes telles que l'ODBC, l'OLE DB, et essayer d'ADO.NET d'énumérer un ensemble de types autorisés de commande, généralement en texte brut, sous forme de table, ou comme procédures stockées. La classe DataCommand étend ce concept en détendant la mesure où ce type de commande proviennent d'une énumération fixe. Cela offre une souplesse en permettant aux fournisseurs de DDEX pour ajouter des types personnalisés de commande, ainsi que des descriptions de comment et quand les commandes peuvent être utilisées.
Notes
Pour fournir la fonction d'exécution des commandes de façon asynchrone, utilisez la classe DataAsyncCommand.Cette classe inclut un ensemble de méthodes qui sont équivalentes à celles de la classe DataCommand, mais ces méthodes fonctionnent de façon asynchrone.
Remarques à l'attention des héritiers
Lorsque vous héritez de la classe DataCommand, vous devez substituer chaque méthode de cette classe qui doit être prise en charge par son implémentation de fournisseur de DDEX. Implémentation de base de chaque méthode dans cette classe lève NotSupportedException.
Notez que la méthode ExecuteWithoutResults a une implémentation de base qui la délègue à la méthode Execute.
Sécurité des threads
Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.