API de UPnP

Información general sobre la tecnología de las API de UPnP.

Para desarrollar API de UPnP, necesita estos encabezados:

• upnp.h
• upnphost.h

Para obtener instrucciones de programación para esta tecnología, consulte:

• API de UPnP

Functions

Anulación El método Abort detiene una operación de carga asincrónica iniciada por IUPnPDescriptionDocument::LoadAsync.
AddCallback El método AddCallback registra la devolución de llamada de una aplicación con el marco UPnP.
AddRequestHeaders Agrega el encabezado HTTP proporcionado a una solicitud HTTP.
Consejo El host del dispositivo invoca el método Advise para empezar a recibir eventos del servicio hospedado.
AsyncOperationComplete El método de devolución de llamada AsyncOperationComplete proporciona una notificación de la finalización de una operación de E/S asincrónica.
BeginInvokeAction El método BeginInvokeAction invoca una acción en un dispositivo en modo asincrónico. Además, si una suscripción de eventos y descarga de SCPD retrasada está optada por participar y aún no se ha realizado, este método iniciará la descarga de SCPD.
BeginQueryStateVariable El método BeginQueryStateVariable inicia una solicitud asincrónica para el valor de la variable de estado de un servicio específico.
BeginSCPDDownload El método BeginSCPDDownload inicia la descarga asincrónica de un documento de descripción del protocolo de control de servicio (SCPD).
BeginSubscribeToEvents BeginSubscribeToEvents inicia la suscripción de eventos en modo asincrónico y registra la devolución de llamada de la aplicación con el marco UPnP.
CancelAsyncFind El método CancelAsyncFind cancela una búsqueda asincrónica.
CancelAsyncOperation El método CancelAsyncOperation cancela una operación asincrónica pendiente iniciada por los métodos BeginInvokeAction, BeginQueryStateVariable, BeginSubscribeToEvents o BeginSCPDDownload.
CreateAsyncFind El método CreateAsyncFind crea una operación de búsqueda asincrónica.
DeviceAdded El marco UPnP invoca el método DeviceAdded para notificar a la aplicación que se ha agregado un dispositivo a la red.
DeviceAddedWithInterface El marco UPnP invoca el método DeviceAddedWithInterface para notificar a la aplicación que se ha agregado un dispositivo a la red.
DeviceByUDN El método DeviceByUDN devuelve el dispositivo con el nombre de dispositivo único (UDN) especificado incluido en el documento de descripción cargado.
DeviceRemoved El marco UPnP invoca el método DeviceRemoved para notificar a la aplicación que se ha quitado un dispositivo de la red.
EndInvokeAction El método EndInvokeAction recupera los resultados de una operación BeginInvokeAction anterior y recupera los argumentos de salida resultantes.
EndQueryStateVariable El método EndQueryStateVariable recupera los resultados de una operación BeginQueryStateVariable anterior y recupera el valor de variable de estado específico del servicio resultante.
EndSCPDDownload El método EndSCPDDownload recupera los resultados de una descarga asincrónica anterior de un documento de descripción del protocolo de control de servicio (SCPD).
EndSubscribeToEvents El método EndSubscribeToEvents recupera los resultados de una operación BeginSubscribeToEvents anterior.
FindByType El método FindByType busca de forma sincrónica los dispositivos por tipo de dispositivo o tipo de servicio.
FindByUDN El método FindByUDN busca de forma sincrónica un dispositivo por su nombre de dispositivo único (UDN).
get__NewEnum La propiedad _NewEnum especifica la interfaz del enumerador IEnumVARIANT o IEnumUnknown para la colección. (IUPnPDevices.get__NewEnum)
get__NewEnum La propiedad _NewEnum especifica la interfaz del enumerador IEnumVARIANT o IEnumUnknown para la colección. (IUPnPServices.get__NewEnum)
get_Children La propiedad Children especifica todos los dispositivos secundarios del dispositivo. Los dispositivos se almacenan en una colección IUPnPDevices.
get_Count La propiedad Count especifica el número de dispositivos de la colección.
get_Count La propiedad Count especifica el número de servicios de la colección.
get_Description La propiedad Description especifica un resumen legible de la funcionalidad del dispositivo.
get_FriendlyName La propiedad FriendlyName especifica el nombre para mostrar del dispositivo para el dispositivo.
get_HasChildren La propiedad HasChildren especifica si el dispositivo tiene dispositivos secundarios.
get_Id La propiedad Id especifica el identificador de servicio para el servicio.
get_IsRootDevice La propiedad IsRootDevice especifica si el dispositivo es el dispositivo más alto del árbol de dispositivos.
get_Item La propiedad Item especifica la interfaz IUPnPDevice de un dispositivo, identificado por el UDN, en la colección.
get_Item La propiedad Item especifica la interfaz IUPnPService de un servicio, identificado por el identificador de servicio, en la colección.
get_LastTransportStatus Para las consultas relacionadas con variables con eventos, la propiedad LastTransportStatus especifica el estado HTTP de la última operación IUPnPService::InvokeAction.
get_LoadResult La propiedad LoadResult especifica el código correcto o de error de una operación de carga completada.
get_ManufacturerName La propiedad ManufacturerName especifica una forma legible del nombre del fabricante del dispositivo.
get_ManufacturerURL La propiedad ManufacturerURL especifica la dirección URL del sitio web del fabricante.
get_ModelName La propiedad ModelName especifica una forma legible del nombre del modelo del dispositivo.
get_ModelNumber La propiedad ModelNumber especifica una forma legible del número de modelo del dispositivo.
get_ModelURL La propiedad ModelURL especifica la dirección URL de una página web que contiene información específica del modelo para el dispositivo.
get_ParentDevice La propiedad ParentDevice especifica el elemento primario del dispositivo.
get_PresentationURL La propiedad PresentationURL especifica la dirección URL de presentación de una página web que controla el dispositivo.
get_ReadyState La propiedad ReadyState especifica el estado de la operación de carga del documento.
get_RootDevice La propiedad RootDevice especifica el dispositivo más alto del árbol de dispositivos. El dispositivo raíz representa un objeto físico.
get_SerialNumber La propiedad SerialNumber especifica una forma legible del número de serie del dispositivo.
get_Services La propiedad Services especifica la lista de servicios proporcionados por el dispositivo.
get_ServiceTypeIdentifier La propiedad ServiceTypeIdentifier especifica el identificador de tipo de servicio para el dispositivo.
get_Type El método Type especifica el identificador uniforme de recursos (URI) del tipo de dispositivo para el dispositivo.
get_UniqueDeviceName La propiedad UniqueDeviceName especifica el nombre de dispositivo único (UDN) del dispositivo. Un UDN es único; no dos dispositivos pueden tener el mismo UDN.
get_UPC La propiedad UPC especifica una forma legible del código del producto.
GetAddressFamily El método GetAddressFamily recupera el valor actual de la marca de familia de direcciones del objeto Device Finder.
GetDocument Recupera el documento de descripción del dispositivo XML para un dispositivo UPnP.
GetDocument El método GetDocument recupera el documento Descripción del protocolo de control de servicio (SCPD) para un objeto de servicio.
GetDocumentURL El método GetDocumentURL devuelve la dirección URL desde la que se puede cargar el documento de descripción del dispositivo.
GetDocumentURL El método GetDocumentURL recupera la dirección URL de descripción del protocolo de control de servicio (SCPD) para un objeto de servicio. Con esta dirección URL, el punto de control UPnP puede descargar el documento SCPD completo.
GetDwordValue El método GetDwordValue obtiene un valor de 4 bytes que proporciona información sobre una solicitud o un solicitante.
GetGuidValue Actualmente no se admite el método GetGuidValue.
GetServiceObject El método GetServiceObject se usa para obtener el puntero IDispatch a un objeto de servicio específico. El host de dispositivo invoca este método una vez por servicio, la primera vez que recibe una solicitud de un servicio.
GetStringValue El método GetStringValue obtiene una cadena que proporciona información sobre una solicitud o un solicitante.
GetUniqueDeviceName El método GetUniqueDeviceName recupera el UDN del dispositivo especificado.
IconURL El método IconURL devuelve una dirección URL desde la que se puede cargar un icono del formato especificado.
Inicialización El método Initialize se usa para inicializar el dispositivo. El host del dispositivo invoca este método.
InvokeAction Invoca un método en el dispositivo.
Cargar El método Load carga un documento de forma sincrónica. Este método no devuelve el control al autor de la llamada hasta que se completa la operación de carga.
LoadAsync El método LoadAsync carga un documento de forma asincrónica. Este método devuelve el control al autor de la llamada inmediatamente y usa la devolución de llamada especificada para notificar al autor de la llamada una vez completada la operación.
LoadComplete El método LoadComplete se invoca cuando el marco UPnP ha terminado de cargar una descripción del dispositivo.
OnStateChanged El método OnStateChanged envía un evento al host del dispositivo con la lista de DISPID de las variables de estado que han cambiado. El host del dispositivo debe consultar el objeto de servicio para obtener el nuevo valor de cada variable de estado que haya cambiado.
OnStateChangedSafe El método OnStateChangedSafe envía un evento al host del dispositivo con la lista de DISPID que han cambiado. El host del dispositivo debe consultar el objeto de servicio para obtener el nuevo valor de cada variable de estado que haya cambiado.
QueryStateVariable El método QueryStateVariable devuelve el valor de la variable de estado del servicio especificado.
RegisterDevice El método RegisterDevice registra un dispositivo con el host del dispositivo. El host del dispositivo almacena la información del dispositivo. A continuación, el host del dispositivo devuelve un identificador de dispositivo y publica y anuncia el dispositivo en la red.
RegisterDeviceProvider El método RegisterDeviceProvider registra un proveedor de dispositivos con el host del dispositivo. El proveedor de dispositivos no se publica en la red. En su lugar, crea dispositivos dinámicamente y los registra mediante RegisterRunningDevice.
RegisterRunningDevice El método RegisterRunningDevice registra un dispositivo en ejecución con el host del dispositivo.
Volver a registrarDevice El método ReregisterDevice vuelve a registrar un dispositivo con el host del dispositivo. El host del dispositivo almacena la información del dispositivo. A continuación, el host del dispositivo devuelve un identificador de dispositivo y publica y anuncia el dispositivo en la red.
ReregisterRunningDevice El método ReregisterRunningDevice vuelve a registrar un dispositivo en ejecución con el host del dispositivo.
RootDevice El método RootDevice devuelve el dispositivo raíz del árbol de dispositivos del documento cargado actualmente.
SearchComplete El marco UPnP invoca el método SearchComplete para notificar a la aplicación que se ha completado la búsqueda inicial de dispositivos de red.
ServiceInstanceDied El método ServiceInstanceDied se invoca cuando un servicio ya no envía eventos.
SetAddressFamily El método SetAddressFamily establece la marca de familia de direcciones del objeto Device Finder, que usa esta marca para filtrar los dispositivos encontrados.
SetServiceEnumProperty El método SetServiceEnumProperty se usa para indicar la participación en la descarga diferida del Protocolo de control de servicios (SCPD) y la suscripción de eventos para los objetos IUPnPService enumerados desde el objeto IUPnPServices.
Iniciar El método Start inicia el proveedor de dispositivos. El host de dispositivo invoca este método después de cargar el proveedor de dispositivos Este método realiza cualquier inicialización requerida por el proveedor de dispositivos.
StartAsyncFind El método StartAsyncFind inicia una operación de búsqueda asincrónica.
StateVariableChanged El método StateVariableChanged se invoca cuando una variable de estado ha cambiado.
Detención El método Stop detiene el proveedor de dispositivos.
Unadvise El host del dispositivo invoca el método Unadvise para dejar de recibir eventos. El host del dispositivo pasa el mismo puntero que hizo cuando invocó el método IUPnPEventSource::Advise.
UnregisterDevice El método UnregisterDevice anula el registro del dispositivo del host del dispositivo. Un dispositivo se anula temporalmente o permanentemente.
UnregisterDeviceProvider El método UnregisterDeviceProvider anula permanentemente el registro y descarga el proveedor de dispositivos del host del dispositivo. Se invoca el método IUPnPDeviceProvider::Stop.

Interfaces

IUPnPAddressFamilyControl La interfaz IUPnPAddressFamilyControl accede a la marca de familia de direcciones del objeto Device Finder.
IUPnPAsyncResult La interfaz IUPnPAsyncResult se usa para notificar al punto de control UPnP de una operación de E/S asincrónica completada.
IUPnPDescriptionDocument La interfaz IUPnPDescriptionDocument permite a una aplicación cargar una descripción del dispositivo.
IUPnPDescriptionDocumentCallback La interfaz IUPnPDescriptionDocumentCallback permite al marco UPnP comunicar los resultados de una operación de carga asincrónica a una aplicación.
IUPnPDevice La interfaz IUPnPDevice permite a una aplicación recuperar información sobre un dispositivo específico.
IUPnPDeviceControl La interfaz IUPnPDeviceControl es el punto central de administración de un dispositivo y sus objetos de servicio.
IUPnPDeviceDocumentAccess La interfaz IUPnPDeviceDocumentAccess permite a una aplicación obtener la dirección URL del documento de descripción del dispositivo.
IUPnPDeviceDocumentAccessEx Proporciona un método para obtener todo el documento de descripción del dispositivo XML para un dispositivo específico.
IUPnPDeviceFinder La interfaz IUPnPDeviceFinder permite a una aplicación encontrar un dispositivo.
IUPnPDeviceFinderAddCallbackWithInterface La interfaz IUPnPDeviceFinderAddCallbackWithInterface permite que el marco UPnP se comunique con una aplicación.
IUPnPDeviceFinderCallback La interfaz IUPnPDeviceFinderCallback permite al marco UPnP comunicar los resultados de una búsqueda asincrónica a una aplicación.
IUPnPDeviceProvider La interfaz IUPnPDeviceProvider permite a un proveedor de dispositivos iniciar y detener su procesamiento.
IUPnPDevices La interfaz IUPnPDevices enumera una colección de dispositivos.
IUPnPEventSink La interfaz IUPnPEventSink permite que un servicio hospedado envíe notificaciones de eventos al host del dispositivo.
IUPnPEventSource La interfaz IUPnPEventSource permite al host de dispositivo administrar las suscripciones de eventos para el servicio hospedado.
IUPnPHttpHeaderControl Permite al autor de la llamada especificar encabezados HTTP adicionales enviados en solicitudes HTTP a un dispositivo.
IUPnPRegistrar La interfaz IUPnPRegistrar registra los dispositivos que se ejecutan en el contexto del host del dispositivo.
IUPnPRemoteEndpointInfo La interfaz IUPnPRemoteEndpointInfo permite a un dispositivo hospedado obtener información sobre un solicitante (es decir, un punto de control) y la solicitud.
IUPnPReregistrar La interfaz IUPnPReregistrar permite a la aplicación volver a registrar un dispositivo basado en UPnP con el host del dispositivo.
IUPnPService La interfaz IUPnPService permite a una aplicación consultar variables de estado e invocar acciones en una instancia de un servicio.
IUPnPServiceAsync Use esta interfaz para consultar de forma asincrónica variables de estado e invocar acciones en una instancia de un servicio .
IUPnPServiceCallback La interfaz IUPnPServiceCallback se usa para enviar notificaciones de eventos a clientes de objetos service.
IUPnPServiceDocumentAccess Use esta interfaz para recuperar y proporcionar el documento descripción del protocolo de control de servicio (SCPD) a una aplicación de punto de control UPnP para exponer acciones admitidas por el servicio y proporcionar información sobre las variables de estado.
IUPnPServiceEnumProperty Use esta interfaz para retrasar la descarga del protocolo de control de servicio (SCPD) y la suscripción de eventos en los objetos IUPnPService enumerados desde el objeto IUPnPServices.
IUPnPServices La interfaz IUPnPServices enumera una colección de servicios.