WsPushBytes, fonction (webservices.h)

  • Article

Établit un rappel à appeler pour écrire des octets dans un élément. Dans certains encodages, cela peut être plus efficace en éliminant une copie des données.

Syntaxe

HRESULT WsPushBytes(
  [in]           WS_XML_WRITER          *writer,
  [in]           WS_PUSH_BYTES_CALLBACK callback,
  [in, optional] void                   *callbackState,
  [in, optional] WS_ERROR               *error
);

Paramètres

[in] writer

Pointeur vers l’objet Writer XML dans lequel les octets sont écrits. Le pointeur doit référencer une WS_XML_WRITER valide et la valeur référencée peut ne pas être NULL.

[in] callback

Ce paramètre est le rappel à appeler pour écrire les données.

[in, optional] callbackState

Pointeur vers un état défini par l’utilisateur passé à la fonction de rappel.

[in, optional] error

Pointeur vers un objet WS_ERROR où des informations supplémentaires sur l’erreur doivent être stockées en cas d’échec de la fonction.

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_E_INVALID_OPERATION
 L’opération n’est pas autorisée en raison de l’état actuel de l’objet.

Remarques

Lors de l’écriture avec le WS_XML_WRITER_MTOM_ENCODING, WsPushBytes permet d’écrire des octets directement dans sa propre partie MIME et d’éviter une copie. Toutefois, à sa discrétion, l’auteur peut choisir d’appeler le rappel immédiatement, de sorte que l’appelant doit être préparé pour cela.

Si l’encodage ne peut pas tirer parti de ce comportement, WsPushBytes appelle immédiatement le rappel et fonctionne comme si WsWriteBytes avait été appelé.

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