Objet SqlXmlCommand (classes managées SQLXML)

Méthodes

L'objet SqlXmlCommand prend en charge plusieurs méthodes, y compris les méthodes suivantes, pour exécuter une commande :

• void ExecuteNonQuery()
  Exécute la commande, mais ne retourne rien. Cette méthode est utile si vous souhaitez exécuter une commande autre qu'une requête (autrement dit, une commande qui ne retourne rien). L'exécution d'un code de mise à jour (updategram) ou d'un DiffGram qui met à jour des enregistrements mais ne retourne rien est un exemple d'une telle méthode.

• Stream ExecuteStream()
  Retourne un nouvel objet Stream. Cette méthode est utile lorsque vous souhaitez que les résultats de la requête vous soient retournés dans un nouveau flux de données. Pour obtenir un exemple fonctionnel, consultez Exécution de requêtes SQL (classes managées SQLXML).

• public void ExecuteToStream(Stream outputStream)
  Écrit les résultats de la requête dans un flux de données existant. Cette méthode est utile lorsque vous avez un flux de données auquel vous voulez ajouter les résultats (par exemple, pour que les résultats de la requête soient écrits dans le System.Web.HttpResponse.OutputStream). Pour obtenir un exemple fonctionnel, consultez Exécution de requêtes SQL (classes managées SQLXML).

• XmlReader ExecuteXmlReader()
  Retourne un objet XmlReader. Vous pouvez utiliser cette méthode pour manipuler directement les données dans l'objet XmlReader ou enficher l'architecture chainable de System.Xml. Pour plus d'informations, consultez la documentation sur Microsoft .NET Framework. Pour obtenir un exemple fonctionnel, consultez Exécution de requêtes SQL à l'aide de la méthode ExecuteXMLReader.

L'objet SqlXmlCommand prend en charge également ces méthodes supplémentaires :

• SqlXmlParameter CreateParameter()
  Crée un objet SqlXmlParameter. Vous pouvez définir des valeurs pour les paramètres Name et Value de cet objet. Cette méthode est utile si vous voulez transmettre des paramètres à une commande. Pour obtenir un exemple fonctionnel, consultez Exécution de requêtes SQL (classes managées SQLXML).

• void ClearParameters()
  Efface le ou les paramètres qui ont été créés pour un objet de commande donné. Cette méthode est utile si vous souhaitez exécuter plusieurs requêtes sur le même objet de commande.

Propriétés

L'objet SqlXmlCommand prend également en charge ces propriétés :

• ClientSideXml
  Si la valeur est True, cela indique que la conversion de l'ensemble de lignes en XML doit se produire sur le client et non pas sur le serveur. Cette propriété s'avère utile si vous souhaitez déplacer la charge de performance vers le niveau intermédiaire. La propriété vous permet également d'imbriquer les procédures stockées existantes avec FOR XML pour obtenir une sortie XML.

• SchemaPath
  Nom du schéma de mappage avec le chemin d'accès au répertoire (par exemple, C:\x\y\MySchema.xml). Cette propriété est utile pour spécifier un schéma de mappage pour des requêtes XPath. Le chemin d'accès spécifié peut être absolu ou relatif. Si le chemin d'accès est relatif, le chemin d'accès de base spécifié dans Base Path est utilisé pour résoudre le chemin d'accès relatif. Si aucun chemin d'accès de base n'est spécifié, le chemin d'accès relatif se rapporte au répertoire en cours. Pour obtenir un exemple fonctionnel, consultez Accès aux fonctionnalités SQLXML dans l'environnement .NET.

• XslPath
  Nom du fichier XSL avec le chemin d'accès au répertoire. Le chemin d'accès spécifié peut être absolu ou relatif. Si le chemin d'accès est relatif, le chemin d'accès de base spécifié dans Base Path est utilisé pour résoudre le chemin d'accès relatif. Si aucun chemin d'accès de base n'est spécifié, le chemin d'accès relatif se rapporte au répertoire en cours. Pour obtenir un exemple fonctionnel, consultez Application d'une transformation XSL (classes managées SQLXML).

• Base Path
  Chemin d'accès de base (chemin d'accès à un répertoire). Cette propriété est utile pour résoudre un chemin d'accès relatif spécifié pour un fichier XSL (en utilisant la propriété XslPath), un fichier de schéma de mappage (en utilisant la propriété SchemaPath) ou une référence de schéma externe dans un modèle XML (spécifiée en utilisant l'attribut mapping-schema).

• OutputEncoding
  Spécifie le codage pour le flux de données retourné lorsque la commande s'exécute. Cette propriété est utile pour demander un codage spécifique pour le flux de données retourné. Entre autres, les codages communément utilisés sont UTF-8, ANSI et Unicode. UTF-8 est le codage par défaut.

• Namespaces
  Permet l'exécution de requêtes XPath qui utilisent des espaces de noms. Pour plus d'informations sur les requêtes XPath avec des espaces de noms, consultez Exécution de requêtes XPath avec des espaces de noms (classes managées SQLXML). Pour obtenir un exemple fonctionnel, consultez Exécution de requêtes XPath (classes managées SQLXML).

• RootTag
  Fournit l'élément racine unique pour XML généré par l'exécution d'une commande. Un document XML valide requiert une balise de niveau racine unique. Si la commande exécutée génère un fragment XML (sans un élément de premier niveau unique), vous pouvez spécifier un élément racine pour les données XML retournées. Pour obtenir un exemple fonctionnel, consultez Application d'une transformation XSL (classes managées SQLXML).

• CommandText
  Texte de la commande. Cette propriété est utilisée pour spécifier le texte de la commande que vous souhaitez exécuter. Pour obtenir un exemple fonctionnel, consultez Exécution de requêtes SQL (classes managées SQLXML).

• CommandStream
  Flux de commande. Cette propriété est utile si vous souhaitez exécuter une commande à partir d'un fichier (par exemple, un modèle XML). Lorsque vous utilisez CommandStream, seules les valeurs "Template", "UpdateGram" et "DiffGram"CommandType sont prises en charge. Pour obtenir un exemple fonctionnel, consultez Exécution de fichiers modèles à l'aide de la propriété CommandStream.

• CommandType
  Identifie le type de commande. Cette propriété est utilisée pour spécifier le type de commande que vous souhaitez exécuter. Les valeurs du tableau ci-dessous déterminent le type de la commande. Pour obtenir un exemple fonctionnel, consultez Accès aux fonctionnalités SQLXML dans l'environnement .NET.

  Valeur	Description
  SqlXmlCommandType.Sql	Exécute une commande SQL (par exemple, SELECT * FROM Employees FOR XML AUTO).
  SqlXmlCommandType.XPath	Exécute une commande XPath (par exemple, Employees[@EmployeeID=1]).
  SqlXmlCommandType.Template	Exécute un modèle XML.
  SqlXmlCommandType.TemplateFile	Exécute un fichier modèle dans le dossier spécifié.
  SqlXmlCommandType.UpdateGram	Exécute un code de mise à jour (updategram).
  SqlXmlCommandType.Diffgram	Exécute un DiffGram.

Voir aussi

Référence