Метод IUPnPServiceAsync::BeginQueryStateVariable (upnp.h)

Метод BeginQueryStateVariable инициирует асинхронный запрос значения переменной состояния из определенной службы. Кроме того, если указано согласие на отложенное скачивание и подписку на события с описанием SCPD, а это еще не было сделано, этот метод инициирует скачивание SCPD и подписку на события.

Синтаксис

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

Параметры

[in] bstrVariableName

Задает запрошенное значение переменной состояния.

[in, optional] pAsyncResult

Указатель на объект IUPnPAsyncResult . После завершения вызова BeginQueryStateVariable UPnP будет использовать метод IUPnPAsyncResult::AsyncOperationComplete для уведомления контрольной точки.

[out] pullRequestID

Указатель на 64-разрядное значение ULONG , используемое для идентификации асинхронной операции ввода-вывода. Точка управления UPnP должна использовать этот дескриптор при завершении или отмене этой операции с помощью EndQueryStateVariable.

Возвращаемое значение

Возвращает S_OK при успешном выполнении. В противном случае метод возвращает код ошибки COM, определенный в WinError.h , или одно из следующих значений:

Код возврата	Описание
E_FAIL	Не удалось запустить асинхронную операцию.
UPNP_E_INVALID_VARIABLE	Запрошенная переменная состояния, указанная bstrVariableName, не существует.

 

Примечание Некоторые значения могут указывать на то, что от устройства, сертифицированного UPnP, была получена ошибка. Дополнительные сведения см. в разделе Коды ошибок устройства.

 

Комментарии

Подписка на события должна быть завершена перед запросом любых переменных событий состояния с помощью этого метода. Если этого не происходит, возвращается UPNP_E_VARIABLE_VALUE_UNKNOWN , а подписка на события будет выполняться внутри. В результате следующий вызов BeginQueryStateVariable будет успешным.

Примечание Для служб без переменных события этот метод всегда будет вести себя должным образом.

 

Требования

Минимальная версия клиента	Windows 8 [только классические приложения]
Минимальная версия сервера	Windows Server 2012 [только классические приложения]
Целевая платформа	Windows
Header	upnp.h
DLL	Upnp.dll

См. также раздел

IUPnPServiceAsync

IUPnPServiceAsync::CancelAsyncOperation