IUPnPDevice::Description (Compact 7)

  • Article

3/12/2014

This method returns a human-readable summary of the device's functionality.

Syntax

HRESULT get_Description(
  BSTR* pbstr
);

Parameters

  • pbstr
    [out] Receives a reference to a string that contains a short description of the intended functionality of devices of this type. This string must be released when it is no longer required. If the device does not specify a description, this parameter is set to NULL.

Return Value

  • S_OK
    This method was successful.
  • E_OUTOFMEMORY
    The device does not specify a URL and pbstr is NULL.

Otherwise, the method returns one of the COM error codes defined in WinError.h.

Remarks

This property is optional and can return NULL.

Requirements

Header

upnp.h

Library

uuid.lib

See Also

Reference

IUPnPDevice