IUPnPServiceAsync::BeginQueryStateVariable, méthode (upnp.h)

Article
08/26/2023

La méthode BeginQueryStateVariable lance une demande asynchrone pour la valeur de variable d’état à partir d’un service spécifique. En outre, si l’option d’adhésion est indiquée pour un téléchargement différé de la description du protocole de contrôle de service (SCPD) et un abonnement à un événement, et qu’il n’a pas déjà eu lieu, cette méthode lance le téléchargement SCPD et l’abonnement aux événements.

Syntaxe

HRESULT BeginQueryStateVariable(
  [in]           BSTR             bstrVariableName,
  [in, optional] IUPnPAsyncResult *pAsyncResult,
  [out]          PULONG64         pullRequestID
);

Paramètres

[in] bstrVariableName

Spécifie la valeur de variable d’état demandée.

[in, optional] pAsyncResult

Pointeur vers un objet IUPnPAsyncResult . Une fois l’appel BeginQueryStateVariable 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 UPnP doit utiliser ce handle lors de la fin ou de l’annulation de cette opération avec EndQueryStateVariable.

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.
UPNP_E_INVALID_VARIABLE	La variable d’état demandée, indiquée par bstrVariableName, n’existe pas.

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 d’appareil.

Remarques

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

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

Configuration requise


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

Partager via