Funzione WsWriteElement (webservices.h)

Articolo
03/03/2024

Scrivere un valore tipizzato come elemento XML.

Sintassi

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
);

Parametri

[in] writer

Writer in cui scrivere l'elemento.

[in] elementDescription

Puntatore a una descrizione di come serializzare l'elemento.

[in] writeOption

Informazioni sulla modalità di allocazione del valore. Per altre informazioni, vedere WS_WRITE_OPTION .

value

Puntatore al valore da serializzare.

[in] valueSize

Dimensione del valore serializzato, in byte.

Se il valore è NULL, la dimensione deve essere 0.

[in, optional] error

Specifica dove archiviare informazioni aggiuntive sull'errore se la funzione ha esito negativo.

Valore restituito

Questa funzione può restituire uno di questi valori.

Codice restituito	Descrizione
WS_E_INVALID_FORMAT	I dati di input non erano nel formato previsto o non hanno il valore previsto.
E_INVALIDARG	Uno o più argomenti non sono validi.
E_OUTOFMEMORY	Memoria insufficiente.

Commenti

Questa API scrive l'elemento iniziale, gli attributi, gli elementi figlio/testo e l'elemento finale che corrisponde al valore specificato.

Se l'API non riesce, lo stato del writer di input diventa indefinito. Le uniche API che possono essere usate nel writer se si verifica sono WsSetOutput e WsSetOutputToBuffer per restituire il writer a uno stato utilizzabile o WsFreeWriter per liberare il writer.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 7 [app desktop \| App UWP]
Server minimo supportato	Windows Server 2008 R2 [app desktop \| App UWP]
Piattaforma di destinazione	Windows
Intestazione	webservices.h
Libreria	WebServices.lib
DLL	WebServices.dll

Condividi tramite