GetDescription Method

INetwork::GetDescription method

The GetDescription method returns a description string for the network.

Syntax


HRESULT STDMETHODCALLTYPE GetDescription(
  [out] BSTR *pszDescription
);

Parameters

pszDescription [out]

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

The pointer passed is NULL.

 

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:
© 2016 Microsoft