Share via

INetCfgComponent::GetHelpText method

  • Article

The GetHelpText method retrieves the description of a network component that the network configuration subsystem displays in the properties dialog for a network connection.

Syntax

HRESULT GetHelpText(
  [out] LPWSTR *ppszwHelpText
);

Parameters

  • ppszwHelpText [out]
    Pointer to a buffer that receives a constant null-terminated string of 16-bit Unicode characters containing the description of a network component.

Return value

Returns zero (S_OK) if successful; otherwise, returns NETCFG_* codes that are defined in Netcfgx.h. If the ppszwHelpText parameter is NULL, GetHelpText returns E_POINTER.

Remarks

After notify objects call GetHelpText to retrieve the description of a network component, GetHelpText allocates the memory required to store the string containing the description. After notify objects finish with the description, they must call the COM CoTaskMemFree function to release the memory. For more information about CoTaskMemFree, see the Microsoft Windows SDK.

Requirements

Target platform

 Desktop

Header

 Netcfgx.h (include Netcfgx.h)

 

 

Send comments about this topic to Microsoft