Fonction WsFlushWriter (webservices.h)

Indique au rédacteur d’appeler le rappel spécifié dans WS_XML_WRITER_STREAM_OUTPUT si suffisamment de données 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 n’est 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 l’appel de la fonction de manière asynchrone ou NULL si l’appel est synchrone.

[in, optional] error

Spécifie l’emplacement où les informations d’erreur supplémentaires doivent être stockées en cas d’échec de la fonction.

Valeur retournée

Cette fonction peut retourner l’une de ces valeurs.

Remarques

L’enregistreur 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 une WS_ASYNC_CONTEXT les données mises en mémoire tampon seront écrites de manière asynchrone.

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

Si WsWriteStartElement a été appelé, mais que l’élément n’a pas été validée (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 que cela se produit, toute API qui tente d’écrire davantage dans le document XML retourne WS_E_INVALID_OPERATION. (Voir Valeurs de retour des services web Windows.)

Configuration requise