Freigeben über

WS_XML_WRITER_PROPERTY_ID-Aufzählung (webservices.h)

  • Artikel

Jede XML Writer-Eigenschaft wird durch eine ID identifiziert und weist einen zugeordneten Wert auf. Diese Aufzählung wird in der WS_XML_WRITER_PROPERTY-Struktur verwendet, die als Parameter zum WsCreateWriter, WsSetOutput, WsSetOutputToBufferund WsWriteXmlBufferToBytesverwendet wird. Es wird auch direkt als Parameter zum WsGetWriterPropertyverwendet.

Syntax

typedef enum {
  WS_XML_WRITER_PROPERTY_MAX_DEPTH = 0,
  WS_XML_WRITER_PROPERTY_ALLOW_FRAGMENT = 1,
  WS_XML_WRITER_PROPERTY_MAX_ATTRIBUTES = 2,
  WS_XML_WRITER_PROPERTY_WRITE_DECLARATION = 3,
  WS_XML_WRITER_PROPERTY_INDENT = 4,
  WS_XML_WRITER_PROPERTY_BUFFER_TRIM_SIZE = 5,
  WS_XML_WRITER_PROPERTY_CHARSET = 6,
  WS_XML_WRITER_PROPERTY_BUFFERS = 7,
  WS_XML_WRITER_PROPERTY_BUFFER_MAX_SIZE = 8,
  WS_XML_WRITER_PROPERTY_BYTES = 9,
  WS_XML_WRITER_PROPERTY_IN_ATTRIBUTE = 10,
  WS_XML_WRITER_PROPERTY_MAX_MIME_PARTS_BUFFER_SIZE = 11,
  WS_XML_WRITER_PROPERTY_INITIAL_BUFFER = 12,
  WS_XML_WRITER_PROPERTY_ALLOW_INVALID_CHARACTER_REFERENCES = 13,
  WS_XML_WRITER_PROPERTY_MAX_NAMESPACES = 14,
  WS_XML_WRITER_PROPERTY_BYTES_WRITTEN = 15,
  WS_XML_WRITER_PROPERTY_BYTES_TO_CLOSE = 16,
  WS_XML_WRITER_PROPERTY_COMPRESS_EMPTY_ELEMENTS = 17,
  WS_XML_WRITER_PROPERTY_EMIT_UNCOMPRESSED_EMPTY_ELEMENTS = 18
} WS_XML_WRITER_PROPERTY_ID;

Konstanten

 
WS_XML_WRITER_PROPERTY_MAX_DEPTH
Wert: 0
Ein ULONG-, der die maximale Tiefe des Dokuments angibt, das der Autor zulässt.

Die Tiefe wird an jedem Punkt durch die Anzahl der geschachtelten Startelemente gemessen.

Eine Tiefe von 0 verhindert, dass Startelemente geschrieben werden.

Diese Eigenschaft ist standardmäßig auf 32 festgelegt.
WS_XML_WRITER_PROPERTY_ALLOW_FRAGMENT
Wert: 1
Eine WS_XML_WRITER_MTOM_ENCODING Struktur, die angibt, ob der Autor mehrere Elemente und nicht leeren Bereich auf der obersten Ebene des Dokuments zulässt. Diese Eigenschaft
ist möglicherweise nicht auf TRUE mit WS_XML_WRITER_MTOM_ENCODINGfestgelegt.

Diese Eigenschaft ist standardmäßig auf FALSE-festgelegt.
WS_XML_WRITER_PROPERTY_MAX_ATTRIBUTES
Wert: 2
Eine ULONG-, die angibt
die maximale Anzahl von Attributen, die der Writer für ein Element zulässt.

Diese Eigenschaft ist standardmäßig auf 128 festgelegt.
WS_XML_WRITER_PROPERTY_WRITE_DECLARATION
Wert: 3
Ein BOOL-, der angibt, ob der Writer am Anfang des Dokuments eine entsprechende XML-Deklaration ausgeben soll.

Diese Eigenschaft ist standardmäßig auf FALSE-festgelegt.
WS_XML_WRITER_PROPERTY_INDENT
Wert: 4
Ein ULONG-, der angibt, wie viele Leerzeichen zum Formatieren des XML-Codes verwendet werden sollen. Wenn der Einzug null ist, tritt keine Formatierung auf.

Diese Eigenschaft ist standardmäßig auf 0 festgelegt.
WS_XML_WRITER_PROPERTY_BUFFER_TRIM_SIZE
Wert: 5
Eine ULONG-, die eine der folgenden Angibt.

Wenn der Writer WS_XML_WRITER_BUFFER_OUTPUTverwendet, ist diese Eigenschaft die maximale Anzahl von Bytes.
der Writer wird für Aufrufe von WsSetOutput- zum Zwecke der Pufferausgabe beibehalten.

Wenn der Writer WS_XML_WRITER_STREAM_OUTPUTverwendet, ist diese Eigenschaft die maximale Anzahl von Bytes.
der Autor über Aufrufe von WsSetOutput- und WsFlushWriter- für
Zweck der Pufferausgabe.

Diese Eigenschaft hat keine Auswirkung, wenn mit WsSetOutputToBufferangegeben wird.

Diese Eigenschaft ist standardmäßig auf 4096 festgelegt.
WS_XML_WRITER_PROPERTY_CHARSET
Wert: 6
Ein WS_CHARSET Wert, der
gibt den Zeichensatz zurück, den der Writer zum Codieren des Dokuments verwendet. Dieser Wert ist nur für
Textdokumente.
WS_XML_WRITER_PROPERTY_BUFFERS
Wert: 7
Eine WS_BUFFERS-Struktur
die einen Satz von Puffern zurückgibt, die die generierten XML-Bytes enthalten.

Wenn der Writer WS_XML_WRITER_BUFFER_OUTPUTverwendet, werden alle generierten Bytes zurückgegeben und
die Puffer sind gültig, bis WsSetOutput- oder WsFreeWriter- aufgerufen wird.

Wenn der Writer WS_XML_WRITER_MTOM_ENCODINGverwendet, darf es keine offenen Elemente geben.
Die unterstützenden MIME-Komponenten werden generiert und in die zurückgegebenen Puffer eingeschlossen. Sobald dies der Fall ist
tritt auf, jede API, die versucht, weiter in das XML-Dokument zu schreiben, gibt WS_E_INVALID_OPERATIONzurück.
(Siehe Rückgabewerte für Windows-Webdienste.)

Diese Eigenschaft ist bei Verwendung von WS_XML_WRITER_STREAM_OUTPUTnicht verfügbar.

Diese Eigenschaft ist für einen Writer nicht verfügbar, der auf ein WS_XML_BUFFERfestgelegt ist.

Dies ist möglicherweise weniger bequem, aber effizienter als die Verwendung von WS_XML_WRITER_PROPERTY_BYTES, da die
Writer muss die Puffer, aus denen das Dokument besteht, nicht in einen einzelnen Puffer verketten.
WS_XML_WRITER_PROPERTY_BUFFER_MAX_SIZE
Wert: 8
Ein ULONG-
Gibt die maximale Anzahl von Bytes an, die der Writer puffert.

Wenn der Autor WS_XML_WRITER_BUFFER_OUTPUTverwendet, ist dies die maximale Anzahl von
Bytes, die für das gesamte Dokument gepuffert werden. Aufrufe an WsFlushWriter keine Auswirkung haben.

Wenn der Autor WS_XML_WRITER_STREAM_OUTPUTverwendet, ist dies die maximale Anzahl von
Daten, die zwischen WsFlushWriter Aufrufen gepuffert werden.

Diese Eigenschaft hat keine Auswirkung, wenn mit WsSetOutputToBufferangegeben wird.
WS_XML_WRITER_PROPERTY_BYTES
Wert: 9
Eine WS_BUFFERS-Struktur
der einen einzelnen Puffer zurückgibt, der die generierten XML-Bytes enthält.

Wenn der Writer WS_XML_WRITER_BUFFER_OUTPUTverwendet, werden alle generierten Bytes zurückgegeben und
Der Puffer ist gültig, bis WsSetOutput- oder WsFreeWriter- aufgerufen wird.

Wenn der Writer WS_XML_WRITER_MTOM_ENCODINGverwendet, darf es keine offenen Elemente geben.
Die unterstützenden MIME-Komponenten werden generiert und in die zurückgegebenen Puffer eingeschlossen. Sobald dies der Fall ist
tritt auf, jede API, die versucht, weiter in das XML-Dokument zu schreiben, gibt WS_E_INVALID_OPERATIONzurück.

Diese Eigenschaft ist bei Verwendung von WS_XML_WRITER_STREAM_OUTPUTnicht verfügbar.

Diese Eigenschaft ist für einen Writer nicht verfügbar, der auf ein WS_XML_BUFFERfestgelegt ist.

Dies kann bequemer, aber weniger effizient sein als die Verwendung von WS_XML_WRITER_PROPERTY_BUFFERS, da die
Writer muss möglicherweise die Puffer verketten, aus denen das Dokument besteht, in einen einzelnen Puffer.
WS_XML_WRITER_PROPERTY_IN_ATTRIBUTE
Wert: 10
Ein BOOL-
gibt an, dass WsWriteStartAttribute- aufgerufen wurde und der Writer
positioniert am Attributinhalt.
WS_XML_WRITER_PROPERTY_MAX_MIME_PARTS_BUFFER_SIZE
Wert: 11
Ein ULONG-, das mit WS_XML_WRITER_MTOM_ENCODINGverwendet wird. Dadurch wird die maximale Datenmenge angegeben, die
wird zum Schreiben der MIME-Teile gepuffert. WsWriteBytes und
WsPullBytes Daten puffern müssen, um die Daten als separate MIME-Komponente auszustrahlen, die
folgt dem Dokument, und dies kann verwendet werden, um zu begrenzen, wie viel gepuffert wird.

Diese Eigenschaft ist standardmäßig auf 65536 festgelegt.
WS_XML_WRITER_PROPERTY_INITIAL_BUFFER
Wert: 12
Eine WS_BYTES Struktur, die einen Puffer enthält, den der Writer zum Codieren des XML-Dokuments verwenden kann. Das ist
nützlich, wenn eine obere Grenze für die Größe der generierten XML-Daten bekannt ist oder der Aufrufer besitzer sein möchte
der Puffer, in dem die Bytes platziert werden.

Wenn die angegebene Größe größer oder gleich WS_XML_WRITER_PROPERTY_BUFFER_MAX_SIZEist, dann
Writer wird nicht von den internen Puffern zugeordnet.

Dieser Puffer kann als einer der Puffer angezeigt werden, die von der Eigenschaft WS_XML_WRITER_PROPERTY_BUFFERS oder WS_XML_WRITER_PROPERTY_BYTESzurückgegeben werden.

Der Aufrufer muss sicherstellen, dass der angegebene Puffer für die Lebensdauer des Writer gültig ist.
WS_XML_WRITER_PROPERTY_ALLOW_INVALID_CHARACTER_REFERENCES
Wert: 13
Eine BOOL-, die mit WS_XML_WRITER_TEXT_ENCODINGverwendet wird. Festlegen dieses Werts auf TRUE Zeichenverweise zulässt
von Zeichen, die von XML 1.0 als ungültig angesehen werden, werden akzeptiert.

Das Festlegen dieser Eigenschaft auf TRUE kann sich auf die Interoperabilität auswirken.

Diese Eigenschaft ist standardmäßig auf FALSE-festgelegt.
WS_XML_WRITER_PROPERTY_MAX_NAMESPACES
Wert: 14
Eine ULONG-, die die maximale Anzahl eindeutiger XMLns-Deklarationen angibt, die jederzeit im Bereich angezeigt werden können.
beim Schreiben des Dokuments.

Diese Eigenschaft ist standardmäßig auf 32 festgelegt.
WS_XML_WRITER_PROPERTY_BYTES_WRITTEN
Wert: 15
Eine ULONG-, die eine der folgenden Angibt.

Wenn der Writer WS_XML_WRITER_BUFFER_OUTPUTverwendet, dann diese Eigenschaft
gibt die Anzahl der Bytes zurück, die in den Writer geschrieben wurden.

Wenn der Writer WS_XML_WRITER_STREAM_OUTPUTverwendet, dann diese Eigenschaft
gibt die Anzahl der Bytes zurück, die seit dem letzten Aufruf an den Writer geschrieben wurden.
WsFlushWriter.

Wenn der Writer zurzeit ein Elementstarttag schreibt, ist die Größe des Starttags nicht enthalten.
der zurückgegebene Wert.

Diese Eigenschaft ist für einen Writer nicht verfügbar, der mit WsSetOutputToBuffer-festgelegt wurde.
WS_XML_WRITER_PROPERTY_BYTES_TO_CLOSE
Wert: 16
Eine ULONG-, die die maximale Anzahl von Bytes zurückgibt, die zum Schließen aller geöffneten Elemente erforderlich sind.

Eine Anwendung kann WS_XML_WRITER_PROPERTY_BYTES_WRITTEN und
WS_XML_WRITER_PROPERTY_BYTES_TO_CLOSE, um ungefähr zu ermitteln, wie viel zusätzliche
Daten können in das Dokument geschrieben werden. Dabei sollte die Anwendung berücksichtigt werden.
die Codierung des dokuments, das geschrieben wird.

Diese Eigenschaft ist für einen Writer nicht verfügbar, der mit WsSetOutputToBuffer-festgelegt wurde.
WS_XML_WRITER_PROPERTY_COMPRESS_EMPTY_ELEMENTS
Wert: 17
Eine BOOL-, die steuert, wie WsCopyNode Elemente ohne Inhalt kopiert.

Wenn diese Eigenschaft auf FALSE-festgelegt ist, behält WsCopyNode bei, ob jedes Element dargestellt wird.
als Start-/End-Tag-Paar oder als leeres Element. Wenn diese Eigenschaft auf TRUE-festgelegt ist, WsCopyNode
Konvertiert Elemente ohne Inhalt in leere Elemente.

Die binäre Codierung unterstützt keine leeren Elemente. Bei Verwendung von WsCopyNode- mit
ein Writer, der die binäre Codierung verwendet, hat diese Eigenschaft keine Auswirkung. Alle leeren Elemente sind
in Elemente ohne Inhalt konvertiert.

Diese Eigenschaft ist standardmäßig FALSE.

Für eine XML-Eingabezeichenfolge wie:



Wenn diese Eigenschaft FALSE-ist, generiert WsCopyNode- die folgende XML:If this property is FALSE, WsCopyNode generiert:



Wenn diese Eigenschaft TRUEist, generiert WsCopyNode- die folgende XML:If this property is TRUE, WsCopyNode will generate the following xml:

WS_XML_WRITER_PROPERTY_EMIT_UNCOMPRESSED_EMPTY_ELEMENTS
Wert: 18
Windows 8 oder höher: Eine BOOL-, die steuert, wie leere Elemente ausgegeben werden.

Wenn dieser Wert auf FALSE-festgelegt ist, wird ein Element, das nur durch Aufrufe von WsWriteStartElement erstellt wird, und WsWriteEndElement- wie folgt ausgegeben:





Wenn dieses Element auf TRUEfestgelegt ist, wird dieses Element wie folgt ausgegeben:

XML



Der Standardwert ist FALSE-

Anforderungen

Anforderung Wert
mindestens unterstützte Client- Windows 7 [Desktop-Apps | UWP-Apps]
mindestens unterstützte Server- Windows Server 2008 R2 [Desktop-Apps | UWP-Apps]
Header- webservices.h