WsWriteXmlBufferToBytes-Funktion (webservices.h)

  • Artikel

Verwendet einen Writer, um eine WS_XML_BUFFER in einen codierten Bytesatz zu konvertieren.

Syntax

HRESULT WsWriteXmlBufferToBytes(
  [in]           WS_XML_WRITER                *writer,
  [in]           WS_XML_BUFFER                *xmlBuffer,
  [in, optional] const WS_XML_WRITER_ENCODING *encoding,
                 const WS_XML_WRITER_PROPERTY *properties,
  [in]           ULONG                        propertyCount,
  [in]           WS_HEAP                      *heap,
                 void                         **bytes,
  [out]          ULONG                        *byteCount,
  [in, optional] WS_ERROR                     *error
);

Parameter

[in] writer

Der Writer, der zum Generieren der codierten Bytes verwendet werden soll.

[in] xmlBuffer

Der zu schreibende XML-Puffer.

[in, optional] encoding

Die Codierung, die beim Generieren der Bytes verwendet werden soll. Wenn NULL, werden die Bytes in utf8 codiert.

properties

Ein Array optionaler Eigenschaften des Writers. Siehe WS_XML_WRITER_PROPERTY.

[in] propertyCount

Die Anzahl der Eigenschaften.

[in] heap

Der Heap, aus dem die Bytes zugeordnet werden sollen.

bytes

Die generierten Bytes werden hier zurückgegeben.

[out] byteCount

Die Anzahl der generierten Bytes wird hier zurückgegeben.

[in, optional] error

Gibt an, wo zusätzliche Fehlerinformationen gespeichert werden sollen, wenn die Funktion fehlschlägt.

Rückgabewert

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode Beschreibung
E_INVALIDARG
 Mindestens ein Argument ist ungültig.
WS_E_INVALID_OPERATION
 Der Vorgang ist aufgrund des aktuellen Zustands des Objekts nicht zulässig.
WS_E_QUOTA_EXCEEDED
 Ein Kontingent wurde überschritten.

Hinweise

Die Funktion generiert den gesamten Inhalt des WS_XML_BUFFER als linearen Satz von Bytes, die aus dem angegebenen Heap in der angegebenen Codierung zugeordnet sind.

Der Writer bleibt nach dem Aufrufen dieser Funktion in einem undefinierten Zustand. WsWriteXmlBufferToBytes kann jedoch wieder mit einem solchen Writer verwendet werden. Andernfalls sollte WsSetOutput oder WsSetOutputToBuffer verwendet werden, um den Writer wieder in einen bekannten Zustand zu versetzen, oder der Writer sollte mithilfe von WsFreeWriter freigegeben werden.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 7 [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 R2 [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile webservices.h
Bibliothek WebServices.lib
DLL WebServices.dll