UPnP-APIs
Übersicht über die Technologie der UPnP-APIs.
Zum Entwickeln von UPnP-APIs benötigen Sie die folgenden Header:
Programmieranleitungen für diese Technologie finden Sie unter:
Abbruch Die Abort-Methode beendet einen asynchronen Ladevorgang, der von IUPnPDescriptionDocument::LoadAsync gestartet wird. |
AddCallback Die AddCallback-Methode registriert den Rückruf einer Anwendung beim UPnP-Framework. |
AddRequestHeaders Fügt den angegebenen HTTP-Header einer HTTP-Anforderung hinzu. |
Beraten Die Advise-Methode wird vom Gerätehost aufgerufen, um mit dem Empfang von Ereignissen vom gehosteten Dienst zu beginnen. |
AsyncOperationComplete Die AsyncOperationComplete-Rückrufmethode stellt eine Benachrichtigung über den Abschluss eines asynchronen E/A-Vorgangs bereit. |
BeginInvokeAction Die BeginInvokeAction-Methode ruft eine Aktion auf einem Gerät im asynchronen Modus auf. Wenn ein verzögerter SCPD-Download und ein Ereignisabonnement aktiviert ist und noch nicht erfolgt ist, initiiert diese Methode den SCPD-Download. |
BeginQueryStateVariable Die BeginQueryStateVariable-Methode initiiert eine asynchrone Anforderung für den Zustandsvariablenwert von einem bestimmten Dienst. |
BeginSCPDDownload Die BeginSCPDDownload-Methode initiiert den asynchronen Download eines SCPD-Dokuments (Service Control Protocol Description). |
BeginSubscribeToEvents BeginSubscribeToEvents initiiert das Ereignisabonnement im asynchronen Modus und registriert den Anwendungsrückruf beim UPnP-Framework. |
CancelAsyncFind Die CancelAsyncFind-Methode bricht eine asynchrone Suche ab. |
CancelAsyncOperation Die CancelAsyncOperation-Methode bricht einen ausstehenden asynchronen Vorgang ab, der von den Methoden BeginInvokeAction, BeginQueryStateVariable, BeginSubscribeToEvents oder BeginSCPDDownload initiiert wird. |
CreateAsyncFind Die CreateAsyncFind-Methode erstellt einen asynchronen Suchvorgang. |
DeviceAdded Die DeviceAdded-Methode wird vom UPnP-Framework aufgerufen, um die Anwendung zu benachrichtigen, dass dem Netzwerk ein Gerät hinzugefügt wurde. |
DeviceAddedWithInterface Die DeviceAddedWithInterface-Methode wird vom UPnP-Framework aufgerufen, um die Anwendung zu benachrichtigen, dass dem Netzwerk ein Gerät hinzugefügt wurde. |
DeviceByUDN Die DeviceByUDN-Methode gibt das Gerät mit dem angegebenen eindeutigen Gerätenamen (UDN) zurück, der im Dokument zur geladenen Beschreibung enthalten ist. |
DeviceRemoved Die DeviceRemoved-Methode wird vom UPnP-Framework aufgerufen, um die Anwendung zu benachrichtigen, dass ein Gerät aus dem Netzwerk entfernt wurde. |
EndInvokeAction Die EndInvokeAction-Methode ruft die Ergebnisse eines vorherigen BeginInvokeAction-Vorgangs und die resultierenden Ausgabeargumente ab. |
EndQueryStateVariable Die EndQueryStateVariable-Methode ruft die Ergebnisse eines vorherigen BeginQueryStateVariable-Vorgangs und den resultierenden dienstspezifischen Zustandsvariablenwert ab. |
EndSCPDHerunterladen Die EndSCPDDownload-Methode ruft die Ergebnisse eines vorherigen asynchronen Downloads eines SCPD-Dokuments (Service Control Protocol Description) ab. |
EndSubscribeToEvents Die EndSubscribeToEvents-Methode ruft die Ergebnisse eines vorherigen BeginSubscribeToEvents-Vorgangs ab. |
FindByType Die FindByType-Methode sucht synchron nach Geräten nach Gerätetyp oder Diensttyp. |
FindByUDN Die FindByUDN-Methode sucht synchron nach einem Gerät anhand seines eindeutigen Gerätenamens (UDN). |
get__NewEnum Die _NewEnum-Eigenschaft gibt entweder die IEnumVARIANT- oder IEnumUnknown-Enumeratorschnittstelle für die Auflistung an. (IUPnPDevices.get__NewEnum) |
get__NewEnum Die _NewEnum-Eigenschaft gibt entweder die IEnumVARIANT- oder IEnumUnknown-Enumeratorschnittstelle für die Auflistung an. (IUPnPServices.get__NewEnum) |
get_Children Die Children-Eigenschaft gibt alle untergeordneten Geräte des Geräts an. Die Geräte werden in einer IUPnPDevices-Sammlung gespeichert. |
get_Count Die Count-Eigenschaft gibt die Anzahl der Geräte in der Auflistung an. |
get_Count Die Count-Eigenschaft gibt die Anzahl der Dienste in der Auflistung an. |
get_Description Die Description-Eigenschaft gibt eine lesbare Zusammenfassung der Funktionalität des Geräts an. |
get_FriendlyName Die FriendlyName-Eigenschaft gibt den Geräteanzeigenamen für das Gerät an. |
get_HasChildren Die HasChildren-Eigenschaft gibt an, ob das Gerät über untergeordnete Geräte verfügt. |
get_Id Die Id-Eigenschaft gibt die Dienst-ID für den Dienst an. |
get_IsRootDevice Die IsRootDevice-Eigenschaft gibt an, ob das Gerät das oberste Gerät in der Gerätestruktur ist. |
Get_item Die Item-Eigenschaft gibt die IUPnPDevice-Schnittstelle für ein Gerät an, das durch den UDN in der Auflistung identifiziert wird. |
Get_item Die Item-Eigenschaft gibt die IUPnPService-Schnittstelle für einen Dienst an, der durch die Dienst-ID in der Auflistung identifiziert wird. |
get_LastTransportStatus Bei Abfragen im Zusammenhang mit Ereignisvariablen gibt die LastTransportStatus-Eigenschaft den HTTP-status des letzten IUPnPService::InvokeAction-Vorgangs an. |
get_LoadResult Die LoadResult-Eigenschaft gibt den Erfolgs- oder Fehlercode eines abgeschlossenen Ladevorgangs an. |
get_ManufacturerName Die ManufacturerName-Eigenschaft gibt eine lesbare Form des Herstellernamens des Geräts an. |
get_ManufacturerURL Die ManufacturerURL-Eigenschaft gibt die URL für die Website des Herstellers an. |
get_ModelName Die ModelName-Eigenschaft gibt eine lesbare Form des Modellnamens des Geräts an. |
get_ModelNumber Die ModelNumber-Eigenschaft gibt eine lesbare Form der Modellnummer des Geräts an. |
get_ModelURL Die ModelURL-Eigenschaft gibt die URL für eine Webseite an, die modellspezifische Informationen für das Gerät enthält. |
get_ParentDevice Die ParentDevice-Eigenschaft gibt das übergeordnete Element des Geräts an. |
get_PresentationURL Die PresentationURL-Eigenschaft gibt die Präsentations-URL für eine Webseite an, die das Gerät steuert. |
get_ReadyState Die ReadyState-Eigenschaft gibt die status des Dokumentladevorgangs an. |
get_RootDevice Die RootDevice-Eigenschaft gibt das oberste Gerät in der Gerätestruktur an. Das Stammgerät stellt ein physisches Objekt dar. |
get_SerialNumber Die SerialNumber-Eigenschaft gibt eine für Menschen lesbare Form der Seriennummer des Geräts an. |
get_Services Die Services-Eigenschaft gibt die Liste der vom Gerät bereitgestellten Dienste an. |
get_ServiceTypeIdentifier Die ServiceTypeIdentifier-Eigenschaft gibt den Diensttypbezeichner für das Gerät an. |
get_Type Die Type-Methode gibt den URI (Uniform Resource Identifier) des Gerätetyps für das Gerät an. |
get_UniqueDeviceName Die UniqueDeviceName-Eigenschaft gibt den eindeutigen Gerätenamen (UDN) des Geräts an. Ein UDN ist eindeutig. keine zwei Geräte können dieselbe UDN haben. |
get_UPC Die UPC-Eigenschaft gibt eine lesbare Form des Produktcodes an. |
GetAddressFamily Die GetAddressFamily-Methode ruft den aktuellen Wert des Adressfamilienflags des Device Finder-Objekts ab. |
GetDocument Ruft das XML-Gerätebeschreibungsdokument für ein UPnP-Gerät ab. |
GetDocument Die GetDocument-Methode ruft das SCPD-Dokument (Service Control Protocol Description) für ein Dienstobjekt ab. |
GetDocumentURL Die GetDocumentURL-Methode gibt die URL zurück, aus der das Dokument zur Gerätebeschreibung geladen werden kann. |
GetDocumentURL Die GetDocumentURL-Methode ruft die SCPD-URL (Service Control Protocol Description) für ein Dienstobjekt ab. Mithilfe dieser URL kann der UPnP-Kontrollpunkt das vollständige SCPD-Dokument herunterladen. |
GetDwordValue Die GetDwordValue-Methode ruft einen 4-Byte-Wert ab, der Informationen zu einer Anforderung oder einem Anforderer bereitstellt. |
GetGuidValue Die GetGuidValue-Methode wird derzeit nicht unterstützt. |
GetServiceObject Die GetServiceObject-Methode wird verwendet, um den IDispatch-Zeiger auf ein bestimmtes Dienstobjekt abzurufen. Der Gerätehost ruft diese Methode einmal pro Dienst auf, wenn er zum ersten Mal eine Anforderung für einen Dienst empfängt. |
GetStringValue Die GetStringValue-Methode ruft eine Zeichenfolge ab, die Informationen zu einer Anforderung oder einem Anforderer bereitstellt. |
GetUniqueDeviceName Die GetUniqueDeviceName-Methode ruft den UDN für das angegebene Gerät ab. |
iconUrl Die IconURL-Methode gibt eine URL zurück, aus der ein Symbol des angegebenen Formats geladen werden kann. |
Initialisieren Die Initialize-Methode wird verwendet, um das Gerät zu initialisieren. Der Gerätehost ruft diese Methode auf. |
Invokeaction Ruft eine Methode auf dem Gerät auf. |
Load Die Load-Methode lädt ein Dokument synchron. Diese Methode gibt erst die Steuerung an den Aufrufer zurück, wenn der Ladevorgang abgeschlossen ist. |
Loadasync Die LoadAsync-Methode lädt ein Dokument asynchron. Diese Methode gibt die Steuerung sofort an den Aufrufer zurück und verwendet den angegebenen Rückruf, um den Aufrufer zu benachrichtigen, wenn der Vorgang abgeschlossen ist. |
Loadcomplete Die LoadComplete-Methode wird aufgerufen, wenn das UPnP-Framework das Laden einer Gerätebeschreibung abgeschlossen hat. |
OnStateChanged Die OnStateChanged-Methode sendet ein Ereignis an den Gerätehost mit der Liste der DISPIDs der Zustandsvariablen, die sich geändert haben. Der Gerätehost muss das Dienstobjekt abfragen, um den neuen Wert für jede Zustandsvariable abzurufen, die sich geändert hat. |
OnStateChangedSafe Die OnStateChangedSafe-Methode sendet ein Ereignis an den Gerätehost mit der Liste der geänderten DISPIDs. Der Gerätehost muss das Dienstobjekt abfragen, um den neuen Wert für jede Zustandsvariable abzurufen, die sich geändert hat. |
QueryStateVariable Die QueryStateVariable-Methode gibt den Wert der Zustandsvariablen des angegebenen Diensts zurück. |
RegisterDevice Die RegisterDevice-Methode registriert ein Gerät beim Gerätehost. Die Geräteinformationen werden vom Gerätehost gespeichert. Anschließend gibt der Gerätehost einen Gerätebezeichner zurück und veröffentlicht und kündigt das Gerät im Netzwerk an. |
RegisterDeviceProvider Die RegisterDeviceProvider-Methode registriert einen Geräteanbieter beim Gerätehost. Der Geräteanbieter wird nicht im Netzwerk veröffentlicht. Stattdessen werden Geräte dynamisch erstellt und mithilfe von RegisterRunningDevice registriert. |
RegisterRunningDevice Die RegisterRunningDevice-Methode registriert ein ausgeführtes Gerät beim Gerätehost. |
Neu registrierenDevice Die ReregisterDevice-Methode registriert ein Gerät erneut beim Gerätehost. Die Geräteinformationen werden vom Gerätehost gespeichert. Anschließend gibt der Gerätehost einen Gerätebezeichner zurück und veröffentlicht und kündigt das Gerät im Netzwerk an. |
ReregisterRunningDevice Die ReregisterRunningDevice-Methode registriert ein ausgeführtes Gerät erneut beim Gerätehost. |
RootDevice Die RootDevice-Methode gibt das Stammgerät der gerätestruktur des aktuell geladenen Dokuments zurück. |
SearchComplete Die SearchComplete-Methode wird vom UPnP-Framework aufgerufen, um die Anwendung darüber zu informieren, dass die anfängliche Suche nach Netzwerkgeräten abgeschlossen wurde. |
ServiceInstanceDied Die ServiceInstanceDied-Methode wird aufgerufen, wenn ein Dienst keine Ereignisse mehr sendet. |
SetAddressFamily Die SetAddressFamily-Methode legt das Adressfamilienflag des Device Finder-Objekts fest, das dieses Flag verwendet, um die gefundenen Geräte zu filtern. |
SetServiceEnumProperty Die SetServiceEnumProperty-Methode wird verwendet, um die Anmeldung für den verzögerten SCPD-Download (Service Control Protocol Description) und das Ereignisabonnement für die aus dem IUPnPServices-Objekt aufgelisteten IUPnPService-Objekte anzugeben. |
Starten Die Start-Methode startet den Geräteanbieter. Der Gerätehost ruft diese Methode auf, nachdem er den Geräteanbieter geladen hat. Diese Methode führt alle vom Geräteanbieter erforderlichen Initialisierungen durch. |
StartAsyncFind Die StartAsyncFind-Methode startet einen asynchronen Suchvorgang. |
StateVariableChanged Die StateVariableChanged-Methode wird aufgerufen, wenn sich eine Zustandsvariable geändert hat. |
Beenden Die Stop-Methode beendet den Geräteanbieter. |
Unadvise Die Unadvise-Methode wird vom Gerätehost aufgerufen, um den Empfang von Ereignissen zu beenden. Der Gerätehost übergibt denselben Zeiger wie beim Aufrufen der IUPnPEventSource::Advise-Methode. |
UnregisterDevice Die UnregisterDevice-Methode hebt die Registrierung des Geräts beim Gerätehost auf. Ein Gerät wird entweder vorübergehend oder dauerhaft nicht registriert. |
UnregisterDeviceProvider Die UnregisterDeviceProvider-Methode hebt die Registrierung endgültig auf und entlädt den Geräteanbieter vom Gerätehost. Die IUPnPDeviceProvider::Stop-Methode wird aufgerufen. |
IUPnPAddressFamilyControl Die IUPnPAddressFamilyControl-Schnittstelle greift auf das Adressfamilienflag des Device Finder-Objekts zu. |
IUPnPAsyncResult Die IUPnPAsyncResult-Schnittstelle wird verwendet, um den UPnP-Kontrollpunkt über einen abgeschlossenen asynchronen E/A-Vorgang zu benachrichtigen. |
IUPnPDescriptionDocument Die IUPnPDescriptionDocument-Schnittstelle ermöglicht es einer Anwendung, eine Gerätebeschreibung zu laden. |
IUPnPDescriptionDocumentCallback Die IUPnPDescriptionDocumentCallback-Schnittstelle ermöglicht es dem UPnP-Framework, die Ergebnisse eines asynchronen Ladevorgangs an eine Anwendung zu kommunizieren. |
IUPnPDevice Die IUPnPDevice-Schnittstelle ermöglicht es einer Anwendung, Informationen zu einem bestimmten Gerät abzurufen. |
IUPnPDeviceControl Die IUPnPDeviceControl-Schnittstelle ist der zentrale Verwaltungspunkt für ein Gerät und dessen Dienstobjekte. |
IUPnPDeviceDocumentAccess Über die IUPnPDeviceDocumentAccess-Schnittstelle kann eine Anwendung die URL des Gerätebeschreibungsdokuments abrufen. |
IUPnPDeviceDocumentAccessEx Stellt eine Methode zum Abrufen des gesamten XML-Gerätebeschreibungsdokuments für ein bestimmtes Gerät bereit. |
IUPnPDeviceFinder Die IUPnPDeviceFinder-Schnittstelle ermöglicht es einer Anwendung, ein Gerät zu finden. |
IUPnPDeviceFinderAddCallbackWithInterface Die IUPnPDeviceFinderAddCallbackWithInterface-Schnittstelle ermöglicht dem UPnP-Framework die Kommunikation mit einer Anwendung. |
IUPnPDeviceFinderCallback Die IUPnPDeviceFinderCallback-Schnittstelle ermöglicht es dem UPnP-Framework, die Ergebnisse einer asynchronen Suche an eine Anwendung zu kommunizieren. |
IUPnPDeviceProvider Die IUPnPDeviceProvider-Schnittstelle ermöglicht es einem Geräteanbieter, die Verarbeitung zu starten und zu beenden. |
IUPnPGeräte Die IUPnPDevices-Schnittstelle listet eine Sammlung von Geräten auf. |
IUPnPEventSink Die IUPnPEventSink-Schnittstelle ermöglicht es einem gehosteten Dienst, Ereignisbenachrichtigungen an den Gerätehost zu senden. |
IUPnPEventSource Die IUPnPEventSource-Schnittstelle ermöglicht es dem Gerätehost, Ereignisabonnements für den gehosteten Dienst zu verwalten. |
IUPnPHttpHeaderControl Ermöglicht dem Aufrufer, zusätzliche HTTP-Header anzugeben, die in HTTP-Anforderungen an ein Gerät gesendet werden. |
IUPnPRegistrar Die IUPnPRegistrar-Schnittstelle registriert die Geräte, die im Kontext des Gerätehosts ausgeführt werden. |
IUPnPRemoteEndpointInfo Die IUPnPRemoteEndpointInfo-Schnittstelle ermöglicht es einem gehosteten Gerät, Informationen über einen Anforderer (d. h. einen Kontrollpunkt) und die Anforderung abzurufen. |
IUPnPReregistrar Die IUPnPReregistrar-Schnittstelle ermöglicht es der Anwendung, ein UPnP-basiertes Gerät erneut beim Gerätehost zu registrieren. |
IUPnPService Die IUPnPService-Schnittstelle ermöglicht es einer Anwendung, Zustandsvariablen abzufragen und Aktionen für eine instance eines Diensts aufzurufen. |
IUPnPServiceAsync Verwenden Sie diese Schnittstelle, um Zustandsvariablen asynchron abzufragen und Aktionen für eine instance eines Diensts aufzurufen. |
IUPnPServiceCallback Die IUPnPServiceCallback-Schnittstelle wird verwendet, um Ereignisbenachrichtigungen an Clients von Dienstobjekten zu senden. |
IUPnPServiceDocumentAccess Verwenden Sie diese Schnittstelle, um das Dokument Service Control Protocol Description (SCPD) für eine UPnP-Steuerungspunktanwendung abzurufen und bereitzustellen, um vom Dienst unterstützte Aktionen verfügbar zu machen und Informationen zu Zustandsvariablen bereitzustellen. |
IUPnPServiceEnumProperty Verwenden Sie diese Schnittstelle, um den Download der Dienststeuerungsprotokollbeschreibung (Service Control Protocol Description, SCPD) und des Ereignisabonnements für die IUPnPService-Objekte zu verzögern, die aus dem IUPnPServices-Objekt aufgezählt werden. |
IUPnPServices Die IUPnPServices-Schnittstelle listet eine Sammlung von Diensten auf. |