WsFlushWriter, fonction (webservices.h)

Article
09/27/2022
2 minutes de lecture

Indique au writer d’appeler le rappel spécifié dans WS_XML_WRITER_STREAM_OUTPUT si des données suffisantes ont été mises en mémoire tampon.

Syntaxe

HRESULT WsFlushWriter(
  [in]           WS_XML_WRITER          *writer,
  [in]           ULONG                  minSize,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

Paramètres

[in] writer

Enregistreur à vider.

[in] minSize

Spécifie le nombre minimal d’octets qui doivent être mis en mémoire tampon pour que le rappel soit appelé. Si moins de ce nombre d’octets sont mis en mémoire tampon, le rappel ne sera pas appelé. Cela peut être utilisé pour réduire le nombre d’E/S qui se produisent lors de l’écriture de petites quantités de données.

Zéro doit être spécifié pour garantir que le rappel est appelé.

[in, optional] asyncContext

Informations sur la façon d’appeler la fonction de manière asynchrone, ou NULL si vous appelez de façon synchrone.

[in, optional] error

Spécifie où des informations d’erreur supplémentaires doivent être stockées si la fonction échoue.

Valeur retournée

Cette fonction peut retourner l’une de ces valeurs.

Code de retour	Description
E_INVALIDARG	Un ou plusieurs arguments ne sont pas valides.
WS_S_ASYNC	L’opération asynchrone est toujours en attente.

Remarques

Le writer met en mémoire tampon toutes les données jusqu’à ce que WsFlushWriter soit appelé.

Si nécessaire, le WsFlushWriter doit être appelé avant WsFreeWriter pour garantir que toutes les données sont émises.

En spécifiant un WS_ASYNC_CONTEXT les données mises en mémoire tampon sont écrites de manière asynchrone.

Cette fonction n’est pas op si l’enregistreur utilise WS_XML_WRITER_BUFFER_OUTPUT.

Si WsWriteStartElement a été appelé, mais que l’élément n’a pas été commité (voir WsWriteStartElement), cet élément ne sera pas vidé.

Si cette fonction est appelée lors de l’utilisation de WS_XML_WRITER_MTOM_ENCODING et qu’il n’existe aucun élément ouvert sur l’enregistreur, les parties MIME de prise en charge sont générées et émises. Une fois cette opération effectuée, toute API qui tente d’écrire plus loin dans le document XML retourne WS_E_INVALID_OPERATION. (Voir Valeurs de retour des services web Windows.)

Configuration requise


Client minimal pris en charge	Windows 7 [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows Server 2008 R2 [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	webservices.h
Bibliothèque	WebServices.lib
DLL	WebServices.dll