WsCreateWriter-Funktion (webservices.h)

Artikel
08/27/2023

erstellt einen XML Writer mit den angegebenen Eigenschaften.

Syntax

HRESULT WsCreateWriter(
                 const WS_XML_WRITER_PROPERTY *properties,
  [in]           ULONG                        propertyCount,
                 WS_XML_WRITER                **writer,
  [in, optional] WS_ERROR                     *error
);

Parameter

properties

Ein Array von WS_XML_WRITER_PROPERTY Strukturen, die optionale Eigenschaften für den XML-Writer enthalten.

Der Wert dieses Parameters kann NULL sein. In diesem Fall muss der propertyCount-Parameter 0 (null) sein.

[in] propertyCount

Die Anzahl der Eigenschaften im Eigenschaftenarray .

writer

Bei Erfolg ein Zeiger, der die Adresse des WS_XML_WRITER Struktur empfängt, die den erstellten XML-Writer darstellt.

Wenn Sie diese Struktur nicht mehr benötigen, müssen Sie sie durch Aufrufen von WsFreeWriter freigeben.

[in, optional] error

Zeiger auf eine WS_ERROR-Struktur , die zusätzliche Fehlerinformationen empfängt, wenn die Funktion fehlschlägt.

Rückgabewert

Wenn die Funktion erfolgreich ist, gibt sie NO_ERROR zurück. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Rückgabecode	Beschreibung
E_INVALIDARG	Mindestens ein Argument ist ungültig.

Hinweise

Verwenden Sie die Funktionen WsSetOutput oder WsSetOutputToBuffer , um die Codierung des XML-Writers auszuwählen und anzugeben, wohin die Ausgabe zu leiten ist.

Ein WS_XML_WRITER kann wiederverwendet werden, indem WsSetOutput oder WsSetOutputToBuffer erneut aufgerufen wird.

Die Eigenschaften, die zum Konfigurieren des Writers verwendet werden können, finden Sie unter WS_XML_WRITER_PROPERTY_ID .

Der XML-Writer puffert alle Daten, bis WsFlushWriter aufgerufen wird. Dadurch kann der Aufrufer bestimmen, mit welcher Granularität Daten geschrieben werden sollen und ob diese Daten asynchron geschrieben werden sollen. Daten werden erst geschrieben , wenn WsFlushWriter aufgerufen wird.

Wenn ein Vorgang für einen WS_XML_WRITER fehlschlägt, wird der Writer in einem fehlerhaften Zustand belassen, und weitere Aufrufe des Writer geben WS_E_OBJECT_FAULTED zurück. (Siehe Rückgabewerte für Windows-Webdienste.) Die einzige mögliche Funktion ruft den XML-Writer auf, wenn dies geschieht, sind WsSetOutput und WsSetOutputToBuffer , um den XML-Writer in einen verwendbaren Zustand zurückzugeben, oder WsFreeWriter , um den XML-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

Freigeben über