Partager via

WsGetMessageProperty, fonction (webservices.h)

  • Article

Récupère une propriété d’objet Message spécifiée. La propriété à récupérer est identifiée par un paramètre d’entrée WS_MESSAGE_PROPERTY_ID .

Syntaxe

HRESULT WsGetMessageProperty(
  [in]           WS_MESSAGE             *message,
  [in]           WS_MESSAGE_PROPERTY_ID id,
                 void                   *value,
  [in]           ULONG                  valueSize,
  [in, optional] WS_ERROR               *error
);

Paramètres

[in] message

Pointeur vers un objet Message contenant la propriété souhaitée. Ce paramètre doit être un objet WS_LISTENER valide.

[in] id

Il s’agit d’une valeur d’énumérateur WS_MESSAGE_PROPERTY_ID qui identifie la propriété souhaitée.

value

Référence à un emplacement pour stocker la valeur de la propriété récupérée. Le pointeur doit avoir un alignement compatible avec le type de la propriété.

[in] valueSize

Taille de mémoire tampon de longueur d’octet allouée par l’appelant pour stocker la valeur de la propriété récupérée.

[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
E_INVALIDARG
 L’ID de propriété n’était pas pris en charge pour cet objet ou la mémoire tampon spécifiée n’était pas assez grande pour la valeur.
E_OUTOFMEMORY
 La mémoire de l’application est insuffisante.
Autres erreurs
Cette fonction peut renvoyer d’autres erreurs non répertoriées ci-dessus.

Configuration requise

   
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