WsFillReader, fonction (webservices.h)

Article
03/03/2024

Garantit que le lecteur a mis en mémoire tampon le nombre minimal d’octets des données XML à utiliser par les fonctions de lecture suivantes. Il appellera le rappel spécifié par WS_XML_READER_STREAM_INPUT autant de fois que nécessaire pour obtenir le nombre d’octets spécifié par la valeur du paramètre minSize . À l’achèvement, les données mises en mémoire tampon sont disponibles pour d’autres fonctions de lecteur. Si une fonction de lecteur suivante nécessite plus de données que ce qui a été obtenu, la fonction retourne une exception WS_E_QUOTA_EXCEEDED . (Voir Valeurs de retour des services Web Windows.)

Syntaxe

HRESULT WsFillReader(
  [in]           WS_XML_READER          *reader,
  [in]           ULONG                  minSize,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

Paramètres

[in] reader

Pointeur vers une structure WS_XML_READER utilisée pour obtenir les données.

[in] minSize

Spécifie le nombre minimal d’octets que le lecteur doit avoir obtenu. Si le nombre d’octets actuel mis en mémoire tampon est égal ou supérieur à la valeur de minSize , la fonction ne fera rien et retournera immédiatement.

[in, optional] asyncContext

Pointeur vers une structure de données WS_ASYNC_CONTEXT avec des informations sur l’appel asynchrone de la fonction. Une valeur NULL indique une demande d’opération synchrone.

[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
WS_S_ASYNC	L’opération asynchrone est toujours en attente.

Remarques

Le nombre d’octets requis pour lire un segment particulier de données XML dépend de l’encodage et de sa mise en forme.

Cette fonction est un « no-op » lorsqu’elle est utilisée avec un lecteur utilisant WS_XML_READER_BUFFER_INPUT.

En spécifiant un WS_ASYNC_CONTEXT les données sont lues de manière asynchrone.

Configuration requise

Condition requise	Valeur
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