Partager via


WsGetChannelProperty, fonction (webservices.h)

Récupère une propriété du canal référencée par le paramètre channel .

Syntaxe

HRESULT WsGetChannelProperty(
  [in]           WS_CHANNEL             *channel,
  [in]           WS_CHANNEL_PROPERTY_ID id,
                 void                   *value,
  [in]           ULONG                  valueSize,
  [in, optional] WS_ERROR               *error
);

Paramètres

[in] channel

Pointeur vers l’objet WS_CHANNEL avec la propriété à récupérer.

[in] id

Représente un identificateur de la propriété à récupérer.

value

Pointeur void référençant l’emplacement pour stocker la propriété récupérée.

Note Le pointeur doit avoir un alignement compatible avec le type de la propriété .

 

[in] valueSize

Nombre d’octets alloués par l’appelant pour stocker 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 suffisamment grande.
E_OUTOFMEMORY
Mémoire insuffisante.
Autres erreurs
Cette fonction peut retourner d’autres erreurs non répertoriées ci-dessus.

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