WsReadMetadata, fonction (webservices.h)

Article
03/06/2024

Lit un élément Metadata et l’ajoute aux documents metadata de l’objet Metadata.

L’état de l’objet Metadata doit être défini sur WS_METADATA_STATE_CREATED.

En cas d’erreur, l’état de l’objet Metadata est réinitialisé à WS_METADATA_STATE_FAULTED.

Note La fonction consomme un élément si l’élément contient des métadonnées. Si l’élément n’est pas reconnu comme contenant des métadonnées, ou si le type particulier de métadonnées n’est pas nécessaire, l’élément qu’il n’est pas lu.

Syntaxe

HRESULT WsReadMetadata(
  [in]           WS_METADATA     *metadata,
  [in]           WS_XML_READER   *reader,
  [in]           const WS_STRING *url,
  [in, optional] WS_ERROR        *error
);

Paramètres

[in] metadata

Pointeur vers l’objet Metadata pour stocker les métadonnées lues. Le pointeur doit référencer un objet WS_METADATA valide.

[in] reader

Pointeur vers l’objet Lecteur XML utilisé pour lire les métadonnées. Le pointeur doit référencer un objet WS_XML_READER valide et le lecteur doit être positionné sur l’élément contenant les métadonnées souhaitées.

[in] url

Pointeur vers un objet WS_STRING référençant l’URL des métadonnées récupérées. L’URL est utilisée pour suivre les documents de métadonnées afin de résoudre les liens basés sur des URL entre les documents.

Note L’URL DOIT être complète. L’URL peut avoir un identificateur de fragment.

Les schémas d’URL suivants sont pris en charge :

WS_URL_HTTP_SCHEME_TYPE
WS_URL_HTTPS_SCHEME_TYPE
WS_URL_NETTCP_SCHEME_TYPE

Chaque URL spécifiée à l’aide de cette fonction doit avoir une URL de base unique. L’URL de base est calculée en supprimant tout identificateur de fragment de l’URL spécifiée.

Par exemple, si les URL suivantes ont été spécifiées :


http://example.com/document1#fragment
http://example.com/document2

Les deux URL de base sont les suivantes :


http://example.com/document1
http://example.com/document2

[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_E_INVALID_FORMAT	Les données d’entrée n’étaient pas au format attendu ou n’avaient pas la valeur attendue.
WS_E_INVALID_OPERATION	L’opération n’est pas autorisée en raison de l’état actuel de l’objet.
WS_E_QUOTA_EXCEEDED	Un quota a été dépassé.
E_OUTOFMEMORY	Mémoire insuffisante.
E_INVALIDARG	Un ou plusieurs arguments ne sont pas valides.
S_FALSE	L’élément n’a pas été consommé.
Autres erreurs	Cette fonction peut retourner d’autres erreurs non répertoriées ci-dessus.

Remarques

Cette fonction reconnaît les types de métadonnées suivants :

Documents WSDL 1.1
documents WS-Policy 1.2

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

Partager via