Fonction WsCreateReader (webservices.h)

Crée un lecteur XML avec les propriétés spécifiées.

Syntaxe

HRESULT WsCreateReader(
                 const WS_XML_READER_PROPERTY *properties,
  [in]           ULONG                        propertyCount,
                 WS_XML_READER                **reader,
  [in, optional] WS_ERROR                     *error
);

Paramètres

properties

Tableau de structures WS_XML_READER_PROPERTY contenant des propriétés facultatives pour le lecteur XML.

La valeur de ce paramètre peut être NULL, auquel cas, le paramètre propertyCount doit être égal à 0 (zéro).

Pour connaître les propriétés que tiy peut utiliser pour configurer le lecteur XML, consultez l’énumération WS_XML_READER_PROPERTY_ID .

[in] propertyCount

Nombre de propriétés dans le tableau de propriétés .

reader

En cas de réussite, un pointeur qui reçoit l’adresse du WS_XML_READER structure représentant le nouveau lecteur XML.

Lorsque vous n’avez plus besoin de cette structure, vous devez la libérer en appelant WsFreeReader.

[in, optional] error

Pointeur vers une structure de WS_ERROR qui reçoit des informations d’erreur supplémentaires en cas d’échec de la fonction.

Valeur retournée

Si la fonction réussit, elle retourne NO_ERROR ; sinon, il retourne un code d’erreur HRESULT.

Remarques

Utilisez les fonctions WsSetInput ou WsSetInputToBuffer pour choisir l’encodage du lecteur XML et indiquer la source de l’entrée.

Si WS_READ_CALLBACK est spécifié dans la structure WS_XML_READER_INPUT passée à la fonction WsSetInput , le lecteur XML lit des données supplémentaires uniquement lorsque WsFillReader est appelé. Cela permet à l’appelant de déterminer à quelle granularité lire les données et s’il faut lire ces données de manière asynchrone.

Une structure WS_XML_READER peut être réutilisée en appelant à nouveau WsSetInput ou WsSetInputToBuffer .

Si une opération d’API qui fonctionne sur un WS_XML_READER échoue, le lecteur XML reste dans un état défectueux et d’autres appels de fonction retournent WS_E_OBJECT_FAULTED. (Voir Valeurs de retour des services web Windows.) Les seules appels de fonction possibles pour le lecteur XML si cela se produit sont WsSetInput et WsSetInputToBuffer pour renvoyer le lecteur XML à un état utilisable, ou WsFreeReader pour libérer l’objet lecteur XML.

Configuration requise