INetwork::GetDescription method (netlistmgr.h)
The GetDescription method returns a description string for the network.
Syntax
HRESULT GetDescription(
[out] BSTR *pszDescription
);
Parameters
[out] pszDescription
Pointer to a string that specifies the text description of the network. This value must be freed using the SysFreeString API.
Return value
Returns S_OK if the method succeeds. Otherwise, the method returns one of the following values.
| Return code | Description |
|---|---|
|
The pointer passed is NULL. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | netlistmgr.h |