IUPnPDevice::get_Description method (upnp.h)
The Description property specifies a human-readable summary of the device's functionality.
Syntax
HRESULT get_Description(
[out] BSTR *pbstr
);
Parameters
[out] pbstr
Receives a reference to a string that contains a short description of the intended functionality of devices of this type. Release this string with SysFreeString when it is no longer required. If the device does not specify a description, this parameter is set to NULL.
Return value
For C++: If this property's "get" method succeeds, the return value is S_OK. If the device does not specify this URL, the return value is S_FALSE and pbstr is NULL. Otherwise, the method returns one of the COM error codes defined in WinError.h.
Remarks
This property is optional and pbstr can return NULL.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | None supported |
| Target Platform | Windows |
| Header | upnp.h |
| DLL | Upnp.dll |