INetwork::SetDescription method (netlistmgr.h)
The SetDescription method sets or replaces the description for a network.
Syntax
HRESULT SetDescription(
[in] BSTR szDescription
);
Parameters
[in] szDescription
Zero-terminated string that contains the description of the network.
Return value
Returns S_OK if the method succeeds. Otherwise, the method returns one of the following values.
| Return code | Description |
|---|---|
|
szDescription is NULL. |
|
The given name is too long. |
Remarks
The maximum length for a network description is 1024 characters.
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 |