Méthode IUPnPServiceAsync ::BeginSubscribeToEvents (upnp.h)

Article
03/03/2024

BeginSubscribeToEvents lance l’abonnement aux événements en mode asynchrone et inscrit le rappel d’application auprès de l’infrastructure UPnP.

Syntaxe

HRESULT BeginSubscribeToEvents(
  [in]           IUnknown         *pUnkCallback,
  [in, optional] IUPnPAsyncResult *pAsyncResult,
  [out]          PULONG64         pullRequestID
);

Paramètres

[in] pUnkCallback

Spécifie la référence à l’objet d’interface qui contient le rappel à inscrire. Cet objet doit prendre en charge l’interface IUPnPServiceCallback ou l’interface IDispatch .

[in, optional] pAsyncResult

Spécifie une référence à l’objet IUPnPAsyncResult . Une fois l’appel BeginSubscribeToEvents terminé, UPnP utilise la méthode IUPnPAsyncResult ::AsyncOperationComplete pour notifier le point de contrôle.

[out] pullRequestID

Pointeur vers une valeur ULONG 64 bits utilisée pour identifier l’opération d’E/S asynchrone. Le point de contrôle doit utiliser ce handle lors de la fin ou de l’annulation de l’opération via EndSubscribeToEvents ou CancelAsyncOperation.

Valeur retournée

Renvoie S_OK en cas de réussite. Sinon, la méthode retourne un code d’erreur COM défini dans WinError.h ou l’une des valeurs suivantes :

Code de retour	Description
E_FAIL	Échec du lancement de l’opération asynchrone.

Note Certaines valeurs peuvent indiquer qu’une erreur a été reçue d’un appareil certifié UPnP. Pour plus d’informations, consultez Codes d’erreur de l’appareil.

Remarques

L’abonnement aux événements doit être terminé avant d’interroger toutes les variables d’état événementielles avec BeginQueryStateVariable. Si ce n’est pas le cas, UPNP_E_VARIABLE_VALUE_UNKNOWN est retourné et l’abonnement aux événements aura lieu en interne. Par conséquent, le prochain appel BeginQueryStateVariable réussit.

Note Pour les services sans variables événementielles, BeginQueryStateVariable se comporte toujours comme prévu.

L’appel de cette méthode plusieurs fois entraîne l’ajout de plusieurs rappels.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 8 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2012 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	upnp.h
DLL	Upnp.dll

Voir aussi

IUPnPServiceAsync

IUPnPServiceAsync ::CancelAsyncOperation

IUPnPServiceAsync ::EndSubscribeToEvents

Partager via