XmlWriter.WriteProcessingInstruction(String, String) Methode

Definition

Namespace:
System.Xml
Assemblys:
System.Xml.dll, System.Xml.ReaderWriter.dll
Assemblys:
netstandard.dll, System.Xml.ReaderWriter.dll
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll
Quelle:
XmlWriter.cs
Quelle:
XmlWriter.cs
Quelle:
XmlWriter.cs
Quelle:
XmlWriter.cs
Quelle:
XmlWriter.cs

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird eine Verarbeitungsanweisung mit einem Leerzeichen zwischen dem Namen und dem Text wie folgt geschrieben: <?name text?>.

public:
 abstract void WriteProcessingInstruction(System::String ^ name, System::String ^ text);
public abstract void WriteProcessingInstruction(string name, string text);
public abstract void WriteProcessingInstruction(string name, string? text);
abstract member WriteProcessingInstruction : string * string -> unit
Public MustOverride Sub WriteProcessingInstruction (name As String, text As String)

Parameter

name
String

Der Name der Verarbeitungsanweisung.

text
String

Der Text, der in die Verarbeitungsanweisung aufgenommen werden soll.

Ausnahmen

ArgumentException

Der Text würde zu einem nicht wohlgeformten XML-Dokument führen.

name ist entweder null oder String.Empty.

Diese Methode wird verwendet, um eine XML-Deklaration zu erstellen, nachdem WriteStartDocument() sie bereits aufgerufen wurde.

InvalidOperationException

Eine XmlWriter Methode wurde aufgerufen, bevor ein vorheriger asynchroner Vorgang abgeschlossen wurde. In diesem Fall InvalidOperationException wird die Meldung "Ein asynchroner Vorgang wird bereits ausgeführt" ausgelöst.

Beispiele

Im folgenden Beispiel wird eine XML-Datei geschrieben, die ein Buch darstellt.

using System;
using System.IO;
using System.Xml;

public class Sample {

  private const string filename = "sampledata.xml";

  public static void Main() {

     XmlWriterSettings settings = new XmlWriterSettings();
     settings.Indent = true;
     XmlWriter writer = XmlWriter.Create(filename, settings);

     // Write the Processing Instruction node.
     String PItext="type=\"text/xsl\" href=\"book.xsl\"";
     writer.WriteProcessingInstruction("xml-stylesheet", PItext);

     // Write the DocumentType node.
     writer.WriteDocType("book", null , null, "<!ENTITY h \"hardcover\">");

     // Write a Comment node.
     writer.WriteComment("sample XML");

     // Write the root element.
     writer.WriteStartElement("book");

     // Write the genre attribute.
     writer.WriteAttributeString("genre", "novel");

     // Write the ISBN attribute.
     writer.WriteAttributeString("ISBN", "1-8630-014");

     // Write the title.
     writer.WriteElementString("title", "The Handmaid's Tale");

     // Write the style element.
     writer.WriteStartElement("style");
     writer.WriteEntityRef("h");
     writer.WriteEndElement();

     // Write the price.
     writer.WriteElementString("price", "19.95");

     // Write CDATA.
     writer.WriteCData("Prices 15% off!!");

     // Write the close tag for the root element.
     writer.WriteEndElement();

     writer.WriteEndDocument();

     // Write the XML to file and close the writer.
     writer.Flush();
     writer.Close();
  }
}

Option Strict
Option Explicit

Imports System.IO
Imports System.Xml

Public Class Sample
    Private Const filename As String = "sampledata.xml"
    
  Public Shared Sub Main()

     Dim settings As XmlWriterSettings = new XmlWriterSettings()
     settings.Indent = true
     Dim writer As XmlWriter = XmlWriter.Create(filename, settings)
        
     ' Write the Processing Instruction node.
     Dim PItext As String = "type=""text/xsl"" href=""book.xsl"""
     writer.WriteProcessingInstruction("xml-stylesheet", PItext)
        
     'Write the DocumentType node.
     writer.WriteDocType("book", Nothing, Nothing, "<!ENTITY h ""hardcover"">")
        
     ' Write a Comment node.
     writer.WriteComment("sample XML")
        
     ' Write the root element.
     writer.WriteStartElement("book")
        
     ' Write the genre attribute
     writer.WriteAttributeString("genre", "novel")
        
     ' Write the ISBN attribute.
     writer.WriteAttributeString("ISBN", "1-8630-014")
        
     ' Write the title.
     writer.WriteElementString("title", "The Handmaid's Tale")
        
     ' Write the style element.
     writer.WriteStartElement("style")
     writer.WriteEntityRef("h")
     writer.WriteEndElement()
       
     ' Write the price.
     writer.WriteElementString("price", "19.95")
        
     ' Write CDATA.
     writer.WriteCData("Prices 15% off!!")
        
     ' Write the close tag for the root element.
     writer.WriteEndElement()
        
     writer.WriteEndDocument()
        
     ' Write the XML to file and close the writer
     writer.Flush()
     writer.Close()
        
    End Sub
End Class

Hinweise

Diese Methode kann verwendet werden, um die XML-Deklaration (statt WriteStartDocument) zu schreiben. Dies kann dazu führen, dass das Codierungsattribut falsch geschrieben wurde. Der folgende C#-Code würde beispielsweise zu einem ungültigen XML-Dokument führen, da die Standardcodierung UTF-8 ist.

XmlWriter writer = XmlWriter.Create("output.xml");
writer.WriteProcessingInstruction("xml", "version='1.0' encoding='UTF-16'");
writer.WriteStartElement("root");
writer.Close();

Ist text dies der null Fall, String.Emptyoder schreibt diese Methode einen ProcessingInstruction mit keinem Dateninhalt, z. B <. ?name?>.

Wenn Text eine ungültige Abfolge von "?>" enthält, kann der XmlWriter Text entweder ein ArgumentException (XmlTextWriter Objekte) auslösen oder ein Leerzeichen einfügen ? >" um zu vermeiden, dass ungültiges XML geschrieben wird (XmlWriter Objekte, die von der Create Methode erstellt wurden).

Die asynchrone Version dieser Methode finden Sie unter WriteProcessingInstructionAsync.

Gilt für: