IUPnPServiceAsync::BeginQueryStateVariable-Methode (upnp.h)

Artikel
08/26/2023

Die BeginQueryStateVariable-Methode initiiert eine asynchrone Anforderung für den Zustandsvariablenwert von einem bestimmten Dienst. Wenn die Anmeldung für einen verzögerten SCPD-Download (Service Control Protocol Description) und ein Ereignisabonnement angegeben ist und dies noch nicht erfolgt ist, initiiert diese Methode außerdem den SCPD-Download und das Ereignisabonnement.

Syntax

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

Parameter

[in] bstrVariableName

Gibt den angeforderten Zustandsvariablenwert an.

[in, optional] pAsyncResult

Zeiger auf ein IUPnPAsyncResult-Objekt . Wenn der BeginQueryStateVariable-Aufruf abgeschlossen ist, verwendet UPnP die IUPnPAsyncResult::AsyncOperationComplete-Methode , um den Kontrollpunkt zu benachrichtigen.

[out] pullRequestID

Zeiger auf einen 64-Bit-ULONG-Wert , der zum Identifizieren des asynchronen E/A-Vorgangs verwendet wird. Der UPnP-Kontrollpunkt muss dieses Handle verwenden, wenn dieser Vorgang mit EndQueryStateVariable beendet oder abgebrochen wird.

Rückgabewert

Gibt bei Erfolg S_OK zurück. Andernfalls gibt die -Methode einen com-Fehlercode zurück, der in WinError.h oder einen der folgenden Werte definiert ist:

Rückgabecode	Beschreibung
E_FAIL	Fehler beim Initiieren des asynchronen Vorgangs.
UPNP_E_INVALID_VARIABLE	Die angeforderte Zustandsvariable, die durch bstrVariableName angegeben wird, ist nicht vorhanden.

Hinweis Einige Werte können darauf hindeuten, dass ein Fehler von einem UPnP-zertifizierten Gerät empfangen wurde. Weitere Informationen finden Sie unter Gerätefehlercodes.

Hinweise

Das Ereignisabonnement sollte abgeschlossen werden, bevor Ereigniszustandsvariablen mit dieser Methode abgefragt werden. Wenn dies nicht der Fall ist, wird UPNP_E_VARIABLE_VALUE_UNKNOWN zurückgegeben, und das Ereignisabonnement erfolgt intern. Daher ist der nächste BeginQueryStateVariable-Aufruf erfolgreich.

Hinweis Bei Diensten ohne Ereignisvariablen verhält sich diese Methode immer wie erwartet.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2012 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	upnp.h
DLL	Upnp.dll

Weitere Informationen

IUPnPServiceAsync

IUPnPServiceAsync::CancelAsyncOperation

Freigeben über