WsWriteElement-Funktion (webservices.h)

  • Artikel

Schreiben Sie einen typisierten Wert als XML-Element.

Syntax

HRESULT WsWriteElement(
  [in]           WS_XML_WRITER                *writer,
  [in]           const WS_ELEMENT_DESCRIPTION *elementDescription,
  [in]           WS_WRITE_OPTION              writeOption,
                 const void                   *value,
  [in]           ULONG                        valueSize,
  [in, optional] WS_ERROR                     *error
);

Parameter

[in] writer

Der Writer, in den das Element geschrieben werden soll.

[in] elementDescription

Ein Zeiger auf eine Beschreibung der Serialisierung des Elements.

[in] writeOption

Informationen dazu, wie der Wert zugeordnet wird. Weitere Informationen finden Sie unter WS_WRITE_OPTION .

value

Ein Zeiger auf den wert, der serialisiert werden soll.

[in] valueSize

Die Größe des werts, der serialisiert wird, in Bytes.

Wenn der Wert NULL ist, sollte die Größe 0 sein.

[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
WS_E_INVALID_FORMAT
 Die Eingabedaten waren nicht im erwarteten Format oder hatten nicht den erwarteten Wert.
E_INVALIDARG
 Mindestens ein Argument ist ungültig.
E_OUTOFMEMORY
 Der Arbeitsspeicher ist nicht mehr vorhanden.

Hinweise

Diese API schreibt das Startelement, die Attribute, untergeordnete Elemente/Text und das Endelement, das dem angegebenen Wert entspricht.

Wenn die API fehlschlägt, wird der Status des Eingabeschreibers nicht definiert. Die einzigen APIs, die in diesem Fall für den Writer verwendet werden können, sind WsSetOutput und WsSetOutputToBuffer , um den Writer in einen verwendbaren Zustand zurückzugeben, oder WsFreeWriter , um den Writer freizugeben.

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