IUPnPDevice::get_Description-Methode (upnp.h)
Die Description-Eigenschaft gibt eine lesbare Zusammenfassung der Funktionalität des Geräts an.
Syntax
HRESULT get_Description(
[out] BSTR *pbstr
);
Parameter
[out] pbstr
Empfängt einen Verweis auf eine Zeichenfolge, die eine kurze Beschreibung der beabsichtigten Funktionalität von Geräten dieses Typs enthält. Geben Sie diese Zeichenfolge mit SysFreeString frei, wenn sie nicht mehr benötigt wird. Wenn das Gerät keine Beschreibung angibt, wird dieser Parameter auf NULL festgelegt.
Rückgabewert
Für C++: Wenn die Get-Methode dieser Eigenschaft erfolgreich ist, wird der Rückgabewert S_OK. Wenn das Gerät diese URL nicht angibt, ist der Rückgabewert S_FALSE und pbstr ist NULL. Andernfalls gibt die Methode einen der com-Fehlercodes zurück, die in WinError.h definiert sind.
Hinweise
Diese Eigenschaft ist optional, und pbstr kann NULL zurückgeben.
Anforderungen
| Unterstützte Mindestversion (Client) | Windows XP [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Nicht unterstützt |
| Zielplattform | Windows |
| Kopfzeile | upnp.h |
| DLL | Upnp.dll |