INetwork::SetDescription method

The SetDescription method sets or replaces the description for a network.

Syntax


HRESULT STDMETHODCALLTYPE SetDescription(
  [in] BSTR szDescription
);

Parameters

szDescription [in]

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 codeDescription
E_POINTER

szDescription is NULL.

HRESULT_FROM_WIN32(ERROR_FILENAME_EXCED_RANGE)

The given name is too long.

 

Remarks

The maximum length for a network description is 1024 characters.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Netlistmgr.h

IDL

Netlistmgr.idl

See also

INetwork

 

 

Community Additions

ADD
Show: