Fonction WsGetPrefixFromNamespace (webservices.h)

Article
03/03/2024

Cette fonction retourne le préfixe auquel un espace de noms est lié. Il peut y avoir plusieurs préfixes dans l’étendue et cette fonction est libre de retourner l’un d’eux.

Note Dans aucune condition, un appelant ne doit dépendre d’un préfixe particulier ou s’attendre à ce qu’un préfixe particulier soit retourné quand plusieurs préfixes peuvent être retournés.

Si la valeur du paramètre requis est définie sur TRUE et que l’espace de noms n’est lié à aucun préfixe , une exception de WS_E_INVALID_FORMAT est retournée. (Voir Valeurs de retour des services web Windows.) Si le paramètre requis est FALSE et que l’espace de noms n’est lié à aucun préfixe, le paramètre préfixe a la valeur NULL et la fonction retourne S_FALSE.

Si WsWriteStartElement est appelé, mais que l’élément n’est pas validé, les espaces de noms et préfixes référencés par l’élément et les attributs de l’élément ne sont pas disponibles pour cette fonction.

Syntaxe

HRESULT WsGetPrefixFromNamespace(
  [in]           WS_XML_WRITER       *writer,
  [in]           const WS_XML_STRING *ns,
  [in]           BOOL                required,
                 const WS_XML_STRING **prefix,
  [in, optional] WS_ERROR            *error
);

Paramètres

[in] writer

Pointeur vers un writer avec l’espace de noms à rechercher. Il doit s’agir d’un objet WS_XML_WRITER valide retourné par WsCreateWriter et peut ne pas avoir la valeur NULL.

[in] ns

Espace de noms à rechercher.

[in] required

Indique si une erreur doit être retournée si un préfixe correspondant est introuvable.

prefix

Référence à un préfixe lié à l’espace de noms ou NULL si la valeur du paramètre requis est FALSE et qu’un espace de noms correspondant est introuvable.

Note La valeur retournée n’est valide que jusqu’à ce que l’enregistreur avance.

[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.

Remarques

Pour l’espace de noms «http://www.w3.org/XML/1998/namespace" ; il retourne le préfixe « xml ».

Pour l’espace de noms «http://www.w3.org/2000/xmlns/" ; il retourne le préfixe « xmlns ».

Le préfixe retourné ne doit pas être modifié et n’est valide que jusqu’à ce que l’enregistreur avance.

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