APIs de UPnP
Visão geral da tecnologia de APIs UPnP.
Para desenvolver APIs UPnP, você precisa destes cabeçalhos:
Para obter diretrizes de programação para essa tecnologia, confira:
Anular O método Abort interrompe uma operação de carregamento assíncrona iniciada por IUPnPDescriptionDocument::LoadAsync. |
Addcallback O método AddCallback registra o retorno de chamada de um aplicativo com a estrutura UPnP. |
AddRequestHeaders Adiciona o cabeçalho HTTP fornecido a uma solicitação HTTP. |
Aconselhar O método Advise é invocado pelo host do dispositivo para começar a receber eventos do serviço hospedado. |
AsyncOperationComplete O método de retorno de chamada AsyncOperationComplete fornece uma notificação da conclusão de uma operação de E/S assíncrona. |
BeginInvokeAction O método BeginInvokeAction invoca uma ação em um dispositivo no modo assíncrono. Além disso, se uma assinatura de evento e download scpd atrasado for aceita e ainda não tiver ocorrido, esse método iniciará o download do SCPD. |
BeginQueryStateVariable O método BeginQueryStateVariable inicia uma solicitação assíncrona para o valor da variável de estado de um serviço específico. |
BeginSCPDDownload O método BeginSCPDDownload inicia o download assíncrono de um documento SCPD (Service Control Protocol Description). |
BeginSubscribeToEvents BeginSubscribeToEvents inicia a assinatura de evento no modo assíncrono e registra o retorno de chamada do aplicativo com a estrutura UPnP. |
CancelAsyncFind O método CancelAsyncFind cancela uma pesquisa assíncrona. |
CancelAsyncOperation O método CancelAsyncOperation cancela uma operação assíncrona pendente iniciada pelos métodos BeginInvokeAction, BeginQueryStateVariable, BeginSubscribeToEvents ou BeginSCPDDownload. |
CreateAsyncFind O método CreateAsyncFind cria uma operação de pesquisa assíncrona. |
DeviceAdded O método DeviceAdded é invocado pela estrutura UPnP para notificar o aplicativo de que um dispositivo foi adicionado à rede. |
DeviceAddedWithInterface O método DeviceAddedWithInterface é invocado pela estrutura UPnP para notificar o aplicativo de que um dispositivo foi adicionado à rede. |
DeviceByUDN O método DeviceByUDN retorna o dispositivo com o UDN (nome de dispositivo exclusivo) especificado contido no documento de descrição carregado. |
DeviceRemoved O método DeviceRemoved é invocado pela estrutura UPnP para notificar o aplicativo de que um dispositivo foi removido da rede. |
EndInvokeAction O método EndInvokeAction recupera os resultados de uma operação BeginInvokeAction anterior e recupera os argumentos de saída resultantes. |
EndQueryStateVariable O método EndQueryStateVariable recupera os resultados de uma operação BeginQueryStateVariable anterior e recupera o valor da variável de estado específica do serviço resultante. |
EndSCPDDownload O método EndSCPDDownload recupera os resultados de um download assíncrono anterior de um documento SCPD (Service Control Protocol Description). |
EndSubscribeToEvents O método EndSubscribeToEvents recupera os resultados de uma operação BeginSubscribeToEvents anterior. |
FindByType O método FindByType pesquisa de forma síncrona dispositivos por tipo de dispositivo ou tipo de serviço. |
FindByUDN O método FindByUDN pesquisa de forma síncrona um dispositivo pelo seu nome de dispositivo exclusivo (UDN). |
get__NewEnum A propriedade _NewEnum especifica a interface do enumerador IEnumVARIANT ou IEnumUnknown para a coleção. (IUPnPDevices.get__NewEnum) |
get__NewEnum A propriedade _NewEnum especifica a interface do enumerador IEnumVARIANT ou IEnumUnknown para a coleção. (IUPnPServices.get__NewEnum) |
get_Children A propriedade Children especifica todos os dispositivos filho do dispositivo. Os dispositivos são armazenados em uma coleção IUPnPDevices. |
get_Count A propriedade Count especifica o número de dispositivos na coleção. |
get_Count A propriedade Count especifica o número de serviços na coleção. |
get_Description A propriedade Description especifica um resumo legível da funcionalidade do dispositivo. |
get_FriendlyName A propriedade FriendlyName especifica o nome de exibição do dispositivo para o dispositivo. |
get_HasChildren A propriedade HasChildren especifica se o dispositivo tem dispositivos filho. |
get_Id A propriedade Id especifica a ID do serviço. |
get_IsRootDevice A propriedade IsRootDevice especifica se o dispositivo é o dispositivo mais alto na árvore de dispositivos. |
Get_item A propriedade Item especifica a interface IUPnPDevice para um dispositivo, identificado pelo UDN, na coleção. |
Get_item A propriedade Item especifica a interface IUPnPService para um serviço, identificada pela ID do serviço, na coleção. |
get_LastTransportStatus Para consultas relacionadas a variáveis evented, a propriedade LastTransportStatus especifica o status HTTP da última operação IUPnPService::InvokeAction. |
get_LoadResult A propriedade LoadResult especifica o código de êxito ou falha de uma operação de carregamento concluída. |
get_ManufacturerName A propriedade ManufacturerName especifica uma forma legível pelo homem do nome do fabricante do dispositivo. |
get_ManufacturerURL A propriedade ManufacturerURL especifica a URL do site do fabricante. |
get_ModelName A propriedade ModelName especifica uma forma legível pelo homem do nome do modelo do dispositivo. |
get_ModelNumber A propriedade ModelNumber especifica uma forma legível por humanos do número do modelo do dispositivo. |
get_ModelURL A propriedade ModelURL especifica a URL de uma página da Web que contém informações específicas do modelo para o dispositivo. |
get_ParentDevice A propriedade ParentDevice especifica o pai do dispositivo. |
get_PresentationURL A propriedade PresentationURL especifica a URL da apresentação para uma página da Web que controla o dispositivo. |
get_ReadyState A propriedade ReadyState especifica o status da operação de carregamento do documento. |
get_RootDevice A propriedade RootDevice especifica o dispositivo mais alto na árvore de dispositivos. O dispositivo raiz representa um objeto físico. |
get_SerialNumber A propriedade SerialNumber especifica uma forma legível por humanos do número de série do dispositivo. |
get_Services A propriedade Services especifica a lista de serviços fornecidos pelo dispositivo. |
get_ServiceTypeIdentifier A propriedade ServiceTypeIdentifier especifica o identificador de tipo de serviço para o dispositivo. |
get_Type O método Type especifica o URI (uniform resource identifier) do tipo de dispositivo para o dispositivo. |
get_UniqueDeviceName A propriedade UniqueDeviceName especifica o UDN (nome do dispositivo) exclusivo do dispositivo. Uma UDN é exclusiva; nenhum dos dois dispositivos pode ter o mesmo UDN. |
get_UPC A propriedade UPC especifica uma forma legível por humanos do código do produto. |
GetAddressFamily O método GetAddressFamily recupera o valor atual do sinalizador da família de endereços do objeto Device Finder. |
GetDocument Recupera o documento de descrição do dispositivo XML para um dispositivo UPnP. |
GetDocument O método GetDocument recupera o documento SCPD (Service Control Protocol Description) para um objeto de serviço. |
GetDocumentURL O método GetDocumentURL retorna a URL da qual o documento de descrição do dispositivo pode ser carregado. |
GetDocumentURL O método GetDocumentURL recupera a URL da SCPD (Descrição do Protocolo de Controle de Serviço) para um objeto de serviço. Usando essa URL, o ponto de controle UPnP pode baixar o documento SCPD completo. |
GetDwordValue O método GetDwordValue obtém um valor de 4 bytes que fornece informações sobre uma solicitação ou solicitante. |
GetGuidValue Atualmente, não há suporte para o método GetGuidValue. |
GetServiceObject O método GetServiceObject é usado para obter o ponteiro IDispatch para um objeto de serviço específico. O host do dispositivo invoca esse método uma vez por serviço, na primeira vez que recebe uma solicitação de um serviço. |
GetStringValue O método GetStringValue obtém uma cadeia de caracteres que fornece informações sobre uma solicitação ou solicitante. |
GetUniqueDeviceName O método GetUniqueDeviceName recupera o UDN para o dispositivo especificado. |
IconURL O método IconURL retorna uma URL da qual um ícone do formato especificado pode ser carregado. |
Initialize O método Initialize é usado para inicializar o dispositivo. O host do dispositivo invoca esse método. |
Invokeaction Invoca um método no dispositivo. |
Carregar O método Load carrega um documento de forma síncrona. Esse método não retorna o controle ao chamador até que a operação de carregamento seja concluída. |
Loadasync O método LoadAsync carrega um documento de forma assíncrona. Esse método retorna o controle ao chamador imediatamente e usa o retorno de chamada especificado para notificar o chamador quando a operação for concluída. |
Loadcomplete O método LoadComplete é invocado quando a estrutura UPnP termina de carregar uma descrição do dispositivo. |
Onstatechanged O método OnStateChanged envia um evento para o host do dispositivo com a lista de DISPIDs das variáveis de estado que foram alteradas. O host do dispositivo deve consultar o objeto de serviço para obter o novo valor para cada variável de estado que foi alterada. |
OnStateChangedSafe O método OnStateChangedSafe envia um evento para o host do dispositivo com a lista de DISPIDs que foram alterados. O host do dispositivo deve consultar o objeto de serviço para obter o novo valor para cada variável de estado que foi alterada. |
QueryStateVariable O método QueryStateVariable retorna o valor da variável de estado do serviço especificado. |
Registerdevice O método RegisterDevice registra um dispositivo com o host do dispositivo. As informações do dispositivo são armazenadas pelo host do dispositivo. Em seguida, o host do dispositivo retorna um identificador de dispositivo e publica e anuncia o dispositivo na rede. |
RegisterDeviceProvider O método RegisterDeviceProvider registra um provedor de dispositivos com o host do dispositivo. O provedor de dispositivos não é publicado na rede. Em vez disso, ele cria dispositivos dinamicamente e os registra usando RegisterRunningDevice. |
Registerrunningdevice O método RegisterRunningDevice registra um dispositivo em execução com o host do dispositivo. |
ReregisterDevice O método ReregisterDevice registra novamente um dispositivo com o host do dispositivo. As informações do dispositivo são armazenadas pelo host do dispositivo. Em seguida, o host do dispositivo retorna um identificador de dispositivo e publica e anuncia o dispositivo na rede. |
ReregisterRunningDevice O método ReregisterRunningDevice registra novamente um dispositivo em execução com o host do dispositivo. |
RootDevice O método RootDevice retorna o dispositivo raiz da árvore de dispositivos do documento carregado no momento. |
SearchComplete O método SearchComplete é invocado pela estrutura UPnP para notificar o aplicativo de que a pesquisa inicial para dispositivos de rede foi concluída. |
ServiceInstanceDied O método ServiceInstanceDied é invocado quando um serviço não está mais enviando eventos. |
SetAddressFamily O método SetAddressFamily define o sinalizador da família de endereços do objeto Device Finder, que usa esse sinalizador para filtrar os dispositivos encontrados. |
SetServiceEnumProperty O método SetServiceEnumProperty é usado para indicar a aceitação para a assinatura de download e evento de SCPD (Descrição do Protocolo de Controle de Serviço) atrasada para os objetos IUPnPService enumerados do objeto IUPnPServices. |
Iniciar O método Start inicia o provedor de dispositivos. O host do dispositivo invoca esse método depois de carregar o provedor de dispositivos Esse método executa qualquer inicialização exigida pelo provedor de dispositivos. |
StartAsyncFind O método StartAsyncFind inicia uma operação de pesquisa assíncrona. |
StateVariableChanged O método StateVariableChanged é invocado quando uma variável de estado é alterada. |
Parar O método Stop interrompe o provedor de dispositivos. |
Unadvise O método Unadvise é invocado pelo host do dispositivo para parar de receber eventos. O host do dispositivo passa o mesmo ponteiro que ele fez quando invocou o método IUPnPEventSource::Advise. |
UnregisterDevice O método UnregisterDevice cancela o registro do dispositivo do host do dispositivo. Um dispositivo está temporariamente ou permanentemente não registrado. |
UnregisterDeviceProvider O método UnregisterDeviceProvider cancela permanentemente o registro e descarrega o provedor do dispositivo do host do dispositivo. O método IUPnPDeviceProvider::Stop é invocado. |
IUPnPAddressFamilyControl A interface IUPnPAddressFamilyControl acessa o sinalizador da família de endereços do objeto Device Finder. |
IUPnPAsyncResult A interface IUPnPAsyncResult é usada para notificar o ponto de controle UPnP de uma operação de E/S assíncrona concluída. |
Iupnpdescriptiondocument A interface IUPnPDescriptionDocument permite que um aplicativo carregue uma descrição do dispositivo. |
IUPnPDescriptionDocumentCallback A interface IUPnPDescriptionDocumentCallback permite que a estrutura UPnP comunique os resultados de uma operação de carga assíncrona a um aplicativo. |
Iupnpdevice A interface IUPnPDevice permite que um aplicativo recupere informações sobre um dispositivo específico. |
Iupnpdevicecontrol A interface IUPnPDeviceControl é o ponto central de gerenciamento para um dispositivo e seus objetos de serviço. |
IUPnPDeviceDocumentAccess A interface IUPnPDeviceDocumentAccess permite que um aplicativo obtenha a URL do documento de descrição do dispositivo. |
IUPnPDeviceDocumentAccessEx Fornece um método para obter todo o documento de descrição do dispositivo XML para um dispositivo específico. |
Iupnpdevicefinder A interface IUPnPDeviceFinder permite que um aplicativo localize um dispositivo. |
IUPnPDeviceFinderAddCallbackWithInterface A interface IUPnPDeviceFinderAddCallbackWithInterface permite que a estrutura UPnP se comunique com um aplicativo |
IUPnPDeviceFinderCallback A interface IUPnPDeviceFinderCallback permite que a estrutura UPnP comunique os resultados de uma pesquisa assíncrona a um aplicativo. |
IUPnPDeviceProvider A interface IUPnPDeviceProvider permite que um provedor de dispositivos inicie e interrompa seu processamento. |
IUPnPDevices A interface IUPnPDevices enumera uma coleção de dispositivos. |
IUPnPEventSink A interface IUPnPEventSink permite que um serviço hospedado envie notificações de eventos para o host do dispositivo. |
IUPnPEventSource A interface IUPnPEventSource permite que o host do dispositivo gerencie assinaturas de evento para o serviço hospedado. |
IUPnPHttpHeaderControl Permite que o chamador especifique cabeçalhos HTTP adicionais enviados em solicitações HTTP para um dispositivo. |
Iupnpregistrar A interface IUPnPRegistrar registra os dispositivos executados no contexto do host do dispositivo. |
IUPnPRemoteEndpointInfo A interface IUPnPRemoteEndpointInfo permite que um dispositivo hospedado obtenha informações sobre um solicitante (ou seja, um ponto de controle) e a solicitação. |
IUPnPReregistrar A interface IUPnPReregistrar permite que o aplicativo registre novamente um dispositivo baseado em UPnP com o host do dispositivo. |
Iupnpservice A interface IUPnPService permite que um aplicativo consulte variáveis de estado e invoque ações em uma instância de um serviço. |
IUPnPServiceAsync Use essa interface para consultar as variáveis de estado de forma assíncrona e invocar ações em uma instância de um serviço . |
IUPnPServiceCallback A interface IUPnPServiceCallback é usada para enviar notificações de eventos para clientes de objetos service. |
IUPnPServiceDocumentAccess Use essa interface para recuperar e fornecer o documento SCPD (Descrição do Protocolo de Controle de Serviço) para um aplicativo de ponto de controle UPnP para expor ações compatíveis com o serviço e fornecer informações sobre variáveis de estado. |
IUPnPServiceEnumProperty Use essa interface para atrasar o download de SCPD (Service Control Protocol Description) e a assinatura de evento nos objetos IUPnPService enumerados do objeto IUPnPServices. |
IUPnPServices A interface IUPnPServices enumera uma coleção de serviços. |