include/netcfgx.idl

   1 /*
   2  *
   3  * Copyright 2014 Alistair Leslie-Hughes
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  18  */
  19
  20 import "unknwn.idl";
  21 import "wtypes.idl";
  22
  23 #ifndef __WIDL__
  24 #define threading(model)
  25 #define progid(str)
  26 #define vi_progid(str)
  27 #endif
  28
  29 [
  30     local,
  31     object,
  32     uuid(c0e8ae99-306e-11d1-aacf-00805fc1270e),
  33     pointer_default(unique)
  34 ]
  35 interface INetCfgComponent : IUnknown
  36 {
  37     typedef enum tagCOMPONENT_CHARACTERISTICS
  38     {
  39         NCF_VIRTUAL                     = 0x00000001,
  40         NCF_SOFTWARE_ENUMERATED         = 0x00000002,
  41         NCF_PHYSICAL                    = 0x00000004,
  42         NCF_HIDDEN                      = 0x00000008,
  43         NCF_NO_SERVICE                  = 0x00000010,
  44         NCF_NOT_USER_REMOVABLE          = 0x00000020,
  45         NCF_MULTIPORT_INSTANCED_ADAPTER = 0x00000040,
  46         NCF_HAS_UI                      = 0x00000080,
  47         NCF_SINGLE_INSTANCE             = 0x00000100,
  48         NCF_FILTER                      = 0x00000400,
  49         NCF_DONTEXPOSELOWER             = 0x00001000,
  50         NCF_HIDE_BINDING                = 0x00002000,
  51         NCF_NDIS_PROTOCOL               = 0x00004000,
  52         NCF_FIXED_BINDING               = 0x00020000,
  53         NCF_LW_FILTER                   = 0x00040000
  54     } COMPONENT_CHARACTERISTICS;
  55
  56     typedef enum tagNCRP_FLAGS
  57     {
  58         NCRP_QUERY_PROPERTY_UI          = 0x00000001,
  59         NCRP_SHOW_PROPERTY_UI           = 0x00000002
  60     } NCRP_FLAGS;
  61
  62     HRESULT GetDisplayName ([out] LPWSTR* ppszwDisplayName);
  63     HRESULT SetDisplayName ([in] LPCWSTR pszwDisplayName);
  64     HRESULT GetHelpText ([out] LPWSTR* pszwHelpText);
  65     HRESULT GetId ([out] LPWSTR* ppszwId);
  66     HRESULT GetCharacteristics ([out] LPDWORD pdwCharacteristics);
  67     HRESULT GetInstanceGuid ([out] GUID* pGuid);
  68     HRESULT GetPnpDevNodeId ([out] LPWSTR* ppszwDevNodeId);
  69     HRESULT GetClassGuid ([out] GUID* pGuid);
  70     HRESULT GetBindName ([out] LPWSTR* ppszwBindName);
  71     HRESULT GetDeviceStatus ([out] ULONG* pulStatus);
  72     HRESULT OpenParamKey ([out] HKEY* phkey);
  73     HRESULT RaisePropertyUi ([in] HWND hwndParent, [in] DWORD dwFlags, [in] IUnknown* punkContext);
  74 };
  75
  76
  77 [
  78     local,
  79     object,
  80     uuid(c0e8ae92-306e-11d1-aacf-00805fc1270e),
  81     pointer_default(unique)
  82 ]
  83 interface IEnumNetCfgComponent : IUnknown
  84 {
  85     HRESULT Next ([in] ULONG celt, [out] INetCfgComponent** rgelt, [out] ULONG *pceltFetched);
  86     HRESULT Skip ([in] ULONG celt);
  87     HRESULT Reset ();
  88     HRESULT Clone ([out] IEnumNetCfgComponent** ppenum);
  89 };
  90
  91 [
  92     local,
  93     object,
  94     uuid(c0e8ae93-306e-11d1-aacf-00805fc1270e),
  95     pointer_default(unique)
  96 ]
  97 interface INetCfg : IUnknown
  98 {
  99     HRESULT Initialize ([in] PVOID pvReserved);
 100     HRESULT Uninitialize ();
 101     HRESULT Apply ();
 102     HRESULT Cancel ();
 103     HRESULT EnumComponents ([in] const GUID* pguidClass, [out] IEnumNetCfgComponent** ppenumComponent);
 104     HRESULT FindComponent ([in] LPCWSTR pszwInfId, [out] INetCfgComponent** pComponent);
 105     HRESULT QueryNetCfgClass ([in] const GUID* pguidClass, [in] REFIID riid,[out] void** ppvObject);
 106 };
 107
 108 [
 109     helpstring("Network Configuration Component Object"),
 110     threading(both),
 111     uuid(5b035261-40f9-11d1-aaec-00805fc1270e)
 112 ]
 113 coclass CNetCfg
 114 {
 115     [default] interface INetCfg;
 116 }