WsGetErrorString, fonction (webservices.h)

Article
03/03/2024

Récupère une chaîne d’erreur à partir d’un objet d’erreur.

Syntaxe

HRESULT WsGetErrorString(
  [in]  WS_ERROR  *error,
  [in]  ULONG     index,
  [out] WS_STRING *string
);

Paramètres

[in] error

Objet d’erreur contenant la chaîne.

[in] index

Index de base zéro identifiant la chaîne à récupérer. La première chaîne d’erreur (index 0) sera la chaîne la plus récemment ajoutée à l’objet error (à l’aide de WsAddErrorString). Lorsque WS_ERROR_PROPERTY_ORIGINAL_ERROR_CODE est présenté dans l’objet error, le texte d’erreur correspondant est disponible dans le dernier index.

Le nombre d’erreurs peut être récupéré à l’aide de WS_ERROR_PROPERTY_STRING_COUNT.

[out] string

Chaîne retournée. La chaîne est valide jusqu’à ce que WsResetError ou WsFreeError soit appelé.

La chaîne n’est pas terminée à zéro.

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.
Autres erreurs	Cette fonction peut retourner d’autres erreurs non répertoriées ci-dessus.

Remarques

La chaîne est dans la langue spécifiée par la propriété LANGID de l’objet error. Vous pouvez la récupérer à l’aide de WsGetErrorProperty avec WS_ERROR_PROPERTY_LANGID.

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