Compartilhar via

Método IUPnPServiceAsync::BeginQueryStateVariable (upnp.h)

  • Artigo

O método BeginQueryStateVariable inicia uma solicitação assíncrona para o valor da variável de estado de um serviço específico. Além disso, se a aceitação for indicada para uma assinatura de download e evento de SCPD (Descrição do Protocolo de Controle de Serviço) atrasada e ainda não tiver ocorrido, esse método iniciará o download do SCPD e a assinatura de evento.

Sintaxe

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

Parâmetros

[in] bstrVariableName

Especifica o valor da variável de estado solicitada.

[in, optional] pAsyncResult

Ponteiro para um objeto IUPnPAsyncResult . Quando a chamada BeginQueryStateVariable for concluída, o UPnP usará o método IUPnPAsyncResult::AsyncOperationComplete para notificar o ponto de controle.

[out] pullRequestID

Ponteiro para um valor ULONG de 64 bits usado para identificar a operação de E/S assíncrona. O ponto de controle UPnP deve usar esse identificador ao encerrar ou cancelar essa operação com EndQueryStateVariable.

Retornar valor

Retornará S_OK se houver êxito. Caso contrário, o método retornará um código de erro COM definido em WinError.h ou um dos seguintes valores:

Código de retorno Descrição
E_FAIL
 Falha ao iniciar a operação assíncrona.
UPNP_E_INVALID_VARIABLE
 A variável de estado solicitada, indicada por bstrVariableName, não existe.
 
Nota Alguns valores podem indicar que um erro foi recebido de um dispositivo certificado por UPnP. Para obter mais informações, consulte Códigos de erro do dispositivo.
 

Comentários

A assinatura do evento deve ser concluída antes de consultar quaisquer variáveis de estado evented com esse método. Se isso não ocorrer, UPNP_E_VARIABLE_VALUE_UNKNOWN será retornado e a assinatura do evento ocorrerá internamente. Como resultado, a próxima chamada BeginQueryStateVariable terá êxito.

Nota Para serviços sem variáveis evented, esse método sempre se comportará conforme o esperado.
 

Requisitos

   
Cliente mínimo com suporte Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2012 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho upnp.h
DLL Upnp.dll

Confira também

IUPnPServiceAsync

IUPnPServiceAsync::CancelAsyncOperation