WsCreateListener, fonction (webservices.h)

Crée un écouteur avec les propriétés spécifiées.

Syntaxe

HRESULT WsCreateListener(
  [in]           WS_CHANNEL_TYPE               channelType,
  [in]           WS_CHANNEL_BINDING            channelBinding,
                 const WS_LISTENER_PROPERTY    *properties,
  [in]           ULONG                         propertyCount,
  [in, optional] const WS_SECURITY_DESCRIPTION *securityDescription,
                 WS_LISTENER                   **listener,
  [in, optional] WS_ERROR                      *error
);

Paramètres

[in] channelType

Type de canal que l’écouteur écoute. Pour les types de canaux, consultez l’énumération WS_CHANNEL_TYPE .

[in] channelBinding

Protocole de canal pour l’écouteur. Pour connaître les liaisons possibles, consultez l’énumération WS_CHANNEL_BINDING .

properties

Pointeur vers une structure WS_LISTENER_PROPERTY contenant des propriétés facultatives pour l’écouteur.

Pour plus d’informations sur les propriétés que vous pouvez spécifier lors de la création d’un écouteur, consultez l’énumération WS_LISTENER_PROPERTY_ID .

Pour plus d’informations sur la création d’un écouteur personnalisé, consultez la section Remarques.

[in] propertyCount

Nombre de propriétés dans le tableau de propriétés .

[in, optional] securityDescription

Pointeur vers une structure WS_SECURITY_DESCRIPTION spécifiant la sécurité de l’écouteur.

Si vous créez un canal personnalisé (à l’aide de la valeur WS_CUSTOM_CHANNEL_BINDING de l’énumération WS_CHANNEL_BINDING ), la description de sécurité doit être NULL. Consultez la section Notes.

listener

En cas de réussite, pointeur qui reçoit l’adresse de l’WS_LISTENER structure représentant le nouvel écouteur.

[in, optional] error

Pointeur vers une structure de WS_ERROR qui reçoit des informations d’erreur supplémentaires en cas d’échec de la fonction.

Valeur retournée

Si la fonction réussit, elle retourne NO_ERROR ; sinon, elle retourne un code d’erreur HRESULT.

Code de retour Description
WS_E_QUOTA_EXCEEDED
Un quota a été dépassé.
E_OUTOFMEMORY
Mémoire insuffisante pour terminer l’opération.
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

Lorsque vous créez un écouteur personnalisé (à l’aide de la valeur WS_CUSTOM_CHANNEL_BINDING de l’énumération WS_CHANNEL_BINDING ), vous pouvez spécifier uniquement les propriétés de canal suivantes :

  • WS_LISTENER_PROPERTY_CUSTOM_LISTENER_CALLBACKS
  • WS_LISTENER_PROPERTY_CUSTOM_LISTENER_PARAMETERS
(Voir l’énumération WS_LISTENER_PROPERTY_ID .) Si d’autres propriétés initiales sont requises pour créer l’écouteur personnalisé, spécifiez-les à l’aide de la propriété WS_LISTENER_PROPERTY_CUSTOM_LISTENER_PARAMETERS.

Pour transmettre des informations de sécurité à une implémentation d’écouteur personnalisé, utilisez la valeur WS_LISTENER_PROPERTY_CUSTOM_LISTENER_PARAMETERS de l’énumération WS_LISTENER_PROPERTY_ID .

Configuration requise

   
Client minimal pris en charge Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible Windows
En-tête webservices.h
Bibliothèque WebServices.lib
DLL WebServices.dll