include/wbemcli.idl

   1 /*
   2  * Copyright 2009 Hans Leidekker for CodeWeavers
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 cpp_quote("DEFINE_GUID(CLSID_WbemLocator, 0x4590f811,0x1d3A,0x11d0,0x89,0x1f,0x00,0xaa,0x00,0x4b,0x2e,0x24);")
  20 cpp_quote("DEFINE_GUID(CLSID_WbemStatusCode, 0xeb87e1bd,0x3233,0x11d2,0xae,0xc9,0x00,0xc0,0x4f,0xb6,0x88,0x20);")
  21
  22 import "objidl.idl";
  23
  24 interface IWbemContext;
  25 interface IWbemServices;
  26 interface IWbemStatusCodeText;
  27 interface IWbemCallResult;
  28 interface IWbemObjectSink;
  29 interface IWbemClassObject;
  30 interface IEnumWbemClassObject;
  31
  32 typedef [v1_enum] enum tag_WBEMSTATUS
  33 {
  34     WBEM_NO_ERROR                           = 0,
  35     WBEM_S_NO_ERROR                         = 0,
  36     WBEM_S_SAME                             = 0,
  37     WBEM_S_FALSE                            = 1,
  38     WBEM_S_ALREADY_EXISTS                   = 0x40001,
  39     WBEM_S_RESET_TO_DEFAULT                 = 0x40002,
  40     WBEM_S_DIFFERENT                        = 0x40003,
  41     WBEM_S_TIMEDOUT                         = 0x40004,
  42     WBEM_S_NO_MORE_DATA                     = 0x40005,
  43     WBEM_S_OPERATION_CANCELLED              = 0x40006,
  44     WBEM_S_PENDING                          = 0x40007,
  45     WBEM_S_DUPLICATE_OBJECTS                = 0x40008,
  46     WBEM_S_ACCESS_DENIED                    = 0x40009,
  47     WBEM_S_PARTIAL_RESULTS                  = 0x40010,
  48     WBEM_S_SOURCE_NOT_AVAILABLE             = 0x40017,
  49     WBEM_E_FAILED                           = 0x80041001,
  50     WBEM_E_NOT_FOUND                        = 0x80041002,
  51     WBEM_E_ACCESS_DENIED                    = 0x80041003,
  52     WBEM_E_PROVIDER_FAILURE                 = 0x80041004,
  53     WBEM_E_TYPE_MISMATCH                    = 0x80041005,
  54     WBEM_E_OUT_OF_MEMORY                    = 0x80041006,
  55     WBEM_E_INVALID_CONTEXT                  = 0x80041007,
  56     WBEM_E_INVALID_PARAMETER                = 0x80041008,
  57     WBEM_E_NOT_AVAILABLE                    = 0x80041009,
  58     WBEM_E_CRITICAL_ERROR                   = 0x8004100a,
  59     WBEM_E_INVALID_STREAM                   = 0x8004100b,
  60     WBEM_E_NOT_SUPPORTED                    = 0x8004100c,
  61     WBEM_E_INVALID_SUPERCLASS               = 0x8004100d,
  62     WBEM_E_INVALID_NAMESPACE                = 0x8004100e,
  63     WBEM_E_INVALID_OBJECT                   = 0x8004100f,
  64     WBEM_E_INVALID_CLASS                    = 0x80041010,
  65     WBEM_E_PROVIDER_NOT_FOUND               = 0x80041011,
  66     WBEM_E_INVALID_PROVIDER_REGISTRATION    = 0x80041012,
  67     WBEM_E_PROVIDER_LOAD_FAILURE            = 0x80041013,
  68     WBEM_E_INITIALIZATION_FAILURE           = 0x80041014,
  69     WBEM_E_TRANSPORT_FAILURE                = 0x80041015,
  70     WBEM_E_INVALID_OPERATION                = 0x80041016,
  71     WBEM_E_INVALID_QUERY                    = 0x80041017,
  72     WBEM_E_INVALID_QUERY_TYPE               = 0x80041018,
  73     WBEM_E_ALREADY_EXISTS                   = 0x80041019,
  74     WBEM_E_OVERRIDE_NOT_ALLOWED             = 0x8004101a,
  75     WBEM_E_PROPAGATED_QUALIFIER             = 0x8004101b,
  76     WBEM_E_PROPAGATED_PROPERTY              = 0x8004101c,
  77     WBEM_E_UNEXPECTED                       = 0x8004101d,
  78     WBEM_E_ILLEGAL_OPERATION                = 0x8004101e,
  79     WBEM_E_CANNOT_BE_KEY                    = 0x8004101f,
  80     WBEM_E_INCOMPLETE_CLASS                 = 0x80041020,
  81     WBEM_E_INVALID_SYNTAX                   = 0x80041021,
  82     WBEM_E_NONDECORATED_OBJECT              = 0x80041022,
  83     WBEM_E_READ_ONLY                        = 0x80041023,
  84     WBEM_E_PROVIDER_NOT_CAPABLE             = 0x80041024,
  85     WBEM_E_CLASS_HAS_CHILDREN               = 0x80041025,
  86     WBEM_E_CLASS_HAS_INSTANCES              = 0x80041026,
  87     WBEM_E_QUERY_NOT_IMPLEMENTED            = 0x80041027,
  88     WBEM_E_ILLEGAL_NULL                     = 0x80041028,
  89     WBEM_E_INVALID_QUALIFIER_TYPE           = 0x80041029,
  90     WBEM_E_INVALID_PROPERTY_TYPE            = 0x8004102a,
  91     WBEM_E_VALUE_OUT_OF_RANGE               = 0x8004102b,
  92     WBEM_E_CANNOT_BE_SINGLETON              = 0x8004102c,
  93     WBEM_E_INVALID_CIM_TYPE                 = 0x8004102d,
  94     WBEM_E_INVALID_METHOD                   = 0x8004102e,
  95     WBEM_E_INVALID_METHOD_PARAMETERS        = 0x8004102f,
  96     WBEM_E_SYSTEM_PROPERTY                  = 0x80041030,
  97     WBEM_E_INVALID_PROPERTY                 = 0x80041031,
  98     WBEM_E_CALL_CANCELLED                   = 0x80041032,
  99     WBEM_E_SHUTTING_DOWN                    = 0x80041033,
 100     WBEM_E_PROPAGATED_METHOD                = 0x80041034,
 101     WBEM_E_UNSUPPORTED_PARAMETER            = 0x80041035,
 102     WBEM_E_MISSING_PARAMETER_ID             = 0x80041036,
 103     WBEM_E_INVALID_PARAMETER_ID             = 0x80041037,
 104     WBEM_E_NONCONSECUTIVE_PARAMETER_IDS     = 0x80041038,
 105     WBEM_E_PARAMETER_ID_ON_RETVAL           = 0x80041039,
 106     WBEM_E_INVALID_OBJECT_PATH              = 0x8004103a,
 107     WBEM_E_OUT_OF_DISK_SPACE                = 0x8004103b,
 108     WBEM_E_BUFFER_TOO_SMALL                 = 0x8004103c,
 109     WBEM_E_UNSUPPORTED_PUT_EXTENSION        = 0x8004103d,
 110     WBEM_E_UNKNOWN_OBJECT_TYPE              = 0x8004103e,
 111     WBEM_E_UNKNOWN_PACKET_TYPE              = 0x8004103f,
 112     WBEM_E_MARSHAL_VERSION_MISMATCH         = 0x80041040,
 113     WBEM_E_MARSHAL_INVALID_SIGNATURE        = 0x80041041,
 114     WBEM_E_INVALID_QUALIFIER                = 0x80041042,
 115     WBEM_E_INVALID_DUPLICATE_PARAMETER      = 0x80041043,
 116     WBEM_E_TOO_MUCH_DATA                    = 0x80041044,
 117     WBEM_E_SERVER_TOO_BUSY                  = 0x80041045,
 118     WBEM_E_INVALID_FLAVOR                   = 0x80041046,
 119     WBEM_E_CIRCULAR_REFERENCE               = 0x80041047,
 120     WBEM_E_UNSUPPORTED_CLASS_UPDATE         = 0x80041048,
 121     WBEM_E_CANNOT_CHANGE_KEY_INHERITANCE    = 0x80041049,
 122     WBEM_E_CANNOT_CHANGE_INDEX_INHERITANCE  = 0x80041050,
 123     WBEM_E_TOO_MANY_PROPERTIES              = 0x80041051,
 124     WBEM_E_UPDATE_TYPE_MISMATCH             = 0x80041052,
 125     WBEM_E_UPDATE_OVERRIDE_NOT_ALLOWED      = 0x80041053,
 126     WBEM_E_UPDATE_PROPAGATED_METHOD         = 0x80041054,
 127     WBEM_E_METHOD_NOT_IMPLEMENTED           = 0x80041055,
 128     WBEM_E_METHOD_DISABLED                  = 0x80041056,
 129     WBEM_E_REFRESHER_BUSY                   = 0x80041057,
 130     WBEM_E_UNPARSABLE_QUERY                 = 0x80041058,
 131     WBEM_E_NOT_EVENT_CLASS                  = 0x80041059,
 132     WBEM_E_MISSING_GROUP_WITHIN             = 0x8004105a,
 133     WBEM_E_MISSING_AGGREGATION_LIST         = 0x8004105b,
 134     WBEM_E_PROPERTY_NOT_AN_OBJECT           = 0x8004105c,
 135     WBEM_E_AGGREGATING_BY_OBJECT            = 0x8004105d,
 136     WBEM_E_UNINTERPRETABLE_PROVIDER_QUERY   = 0x8004105f,
 137     WBEM_E_BACKUP_RESTORE_WINMGMT_RUNNING   = 0x80041060,
 138     WBEM_E_QUEUE_OVERFLOW                   = 0x80041061,
 139     WBEM_E_PRIVILEGE_NOT_HELD               = 0x80041062,
 140     WBEM_E_INVALID_OPERATOR                 = 0x80041063,
 141     WBEM_E_LOCAL_CREDENTIALS                = 0x80041064,
 142     WBEM_E_CANNOT_BE_ABSTRACT               = 0x80041065,
 143     WBEM_E_AMENDED_OBJECT                   = 0x80041066,
 144     WBEM_E_CLIENT_TOO_SLOW                  = 0x80041067,
 145     WBEM_E_NULL_SECURITY_DESCRIPTOR         = 0x80041068,
 146     WBEM_E_TIMED_OUT                        = 0x80041069,
 147     WBEM_E_INVALID_ASSOCIATION              = 0x8004106a,
 148     WBEM_E_AMBIGUOUS_OPERATION              = 0x8004106b,
 149     WBEM_E_QUOTA_VIOLATION                  = 0x8004106c,
 150     WBEM_E_RESERVED_001                     = 0x8004106d,
 151     WBEM_E_RESERVED_002                     = 0x8004106e,
 152     WBEM_E_UNSUPPORTED_LOCALE               = 0x8004106f,
 153     WBEM_E_HANDLE_OUT_OF_DATE               = 0x80041070,
 154     WBEM_E_CONNECTION_FAILED                = 0x80041071,
 155     WBEM_E_INVALID_HANDLE_REQUEST           = 0x80041072,
 156     WBEM_E_PROPERTY_NAME_TOO_WIDE           = 0x80041073,
 157     WBEM_E_CLASS_NAME_TOO_WIDE              = 0x80041074,
 158     WBEM_E_METHOD_NAME_TOO_WIDE             = 0x80041075,
 159     WBEM_E_QUALIFIER_NAME_TOO_WIDE          = 0x80041076,
 160     WBEM_E_RERUN_COMMAND                    = 0x80041077,
 161     WBEM_E_DATABASE_VER_MISMATCH            = 0x80041078,
 162     WBEM_E_VETO_DELETE                      = 0x80041079,
 163     WBEM_E_VETO_PUT                         = 0x8004107a,
 164     WBEM_E_INVALID_LOCALE                   = 0x80041080,
 165     WBEM_E_PROVIDER_SUSPENDED               = 0x80041081,
 166     WBEM_E_SYNCHRONIZATION_REQUIRED         = 0x80041082,
 167     WBEM_E_NO_SCHEMA                        = 0x80041083,
 168     WBEM_E_PROVIDER_ALREADY_REGISTERED      = 0x80041084,
 169     WBEM_E_PROVIDER_NOT_REGISTERED          = 0x80041085,
 170     WBEM_E_FATAL_TRANSPORT_ERROR            = 0x80041086,
 171     WBEM_E_ENCRYPTED_CONNECTION_REQUIRED    = 0x80041087,
 172     WBEM_E_PROVIDER_TIMED_OUT               = 0x80041088,
 173     WBEM_E_NO_KEY                           = 0x80041089,
 174     WBEM_E_PROVIDER_DISABLED                = 0x8004108a
 175 } WBEMSTATUS;
 176
 177 [
 178     object,
 179     restricted,
 180     local,
 181     uuid(dc12a687-737f-11cf-884d-00aa004b2e24),
 182     pointer_default(unique)
 183 ]
 184 interface IWbemLocator : IUnknown
 185 {
 186     HRESULT ConnectServer(
 187         [in] const BSTR strNetworkResource,
 188         [in] const BSTR strUser,
 189         [in] const BSTR strPassword,
 190         [in] const BSTR strLocale,
 191         [in] LONG lSecurityFlags,
 192         [in] const BSTR strAuthority,
 193         [in] IWbemContext *pCtx,
 194         [out] IWbemServices **ppNamespace);
 195 };
 196
 197 [
 198     object,
 199     local,
 200     uuid(eb87e1bc-3233-11d2-aec9-00c04fb68820)
 201 ]
 202 interface IWbemStatusCodeText : IUnknown
 203 {
 204     HRESULT GetErrorCodeText(
 205         [in] HRESULT hRes,
 206         [in] LCID LocaleId,
 207         [in] LONG lFlags,
 208         [out] BSTR *MessageText);
 209
 210     HRESULT GetFacilityCodeText(
 211         [in] HRESULT hRes,
 212         [in] LCID LocaleId,
 213         [in] LONG lFlags,
 214         [out] BSTR *MessageText);
 215 };
 216
 217 typedef [v1_enum] enum tag_WBEM_GENERIC_FLAG_TYPE
 218 {
 219     WBEM_FLAG_RETURN_WBEM_COMPLETE      = 0,
 220     WBEM_FLAG_BIDIRECTIONAL             = 0,
 221     WBEM_FLAG_RETURN_ERROR_OBJECT       = 0,
 222     WBEM_FLAG_DONT_SEND_STATUS          = 0,
 223     WBEM_FLAG_SEND_ONLY_SELECTED        = 0,
 224     WBEM_FLAG_RETURN_IMMEDIATELY        = 0x10,
 225     WBEM_FLAG_FORWARD_ONLY              = 0x20,
 226     WBEM_FLAG_NO_ERROR_OBJECT           = 0x40,
 227     WBEM_FLAG_SEND_STATUS               = 0x80,
 228     WBEM_FLAG_ENSURE_LOCATABLE          = 0x100,
 229     WBEM_FLAG_DIRECT_READ               = 0x200,
 230     WBEM_MASK_RESERVED_FLAGS            = 0x1f000,
 231     WBEM_FLAG_USE_AMENDED_QUALIFIERS    = 0x20000,
 232     WBEM_FLAG_STRONG_VALIDATION         = 0x100000
 233 } WBEM_GENERIC_FLAG_TYPE;
 234
 235 [
 236     object,
 237     restricted,
 238     uuid(9556dc99-828c-11cf-a37e-00aa003240c7),
 239     pointer_default(unique)
 240 ]
 241 interface IWbemServices : IUnknown
 242 {
 243     HRESULT OpenNamespace(
 244         [in] const BSTR strNamespace,
 245         [in] long lFlags,
 246         [in] IWbemContext *pCtx,
 247         [out] IWbemServices **ppWorkingNamespace,
 248         [out] IWbemCallResult **ppResult);
 249
 250     HRESULT CancelAsyncCall(
 251         [in] IWbemObjectSink *pSink);
 252
 253     HRESULT QueryObjectSink(
 254         [in] long lFlags,
 255         [out] IWbemObjectSink **ppResponseHandler);
 256
 257     HRESULT GetObject(
 258         [in] const BSTR strObjectPath,
 259         [in] long lFlags,
 260         [in] IWbemContext *pCtx,
 261         [out] IWbemClassObject **ppObject,
 262         [out] IWbemCallResult **ppCallResult);
 263
 264     HRESULT GetObjectAsync(
 265         [in] const BSTR strObjectPath,
 266         [in] long lFlags,
 267         [in] IWbemContext *pCtx,
 268         [in] IWbemObjectSink *pResponseHandler);
 269
 270     HRESULT PutClass(
 271         [in] IWbemClassObject *pObject,
 272         [in] long lFlags,
 273         [in] IWbemContext *pCtx,
 274         [out] IWbemCallResult **ppCallResult);
 275
 276     HRESULT PutClassAsync(
 277         [in] IWbemClassObject *pObject,
 278         [in] long lFlags,
 279         [in] IWbemContext *pCtx,
 280         [in] IWbemObjectSink *pResponseHandler);
 281
 282     HRESULT DeleteClass(
 283         [in] const BSTR strClass,
 284         [in] long lFlags,
 285         [in] IWbemContext *pCtx,
 286         [out] IWbemCallResult **ppCallResult);
 287
 288     HRESULT DeleteClassAsync(
 289         [in] const BSTR strClass,
 290         [in] long lFlags,
 291         [in] IWbemContext *pCtx,
 292         [in] IWbemObjectSink *pResponseHandler);
 293
 294     HRESULT CreateClassEnum(
 295         [in] const BSTR strSuperclass,
 296         [in] long lFlags,
 297         [in] IWbemContext *pCtx,
 298         [out] IEnumWbemClassObject **ppEnum);
 299
 300     HRESULT CreateClassEnumAsync(
 301         [in] const BSTR strSuperclass,
 302         [in] long lFlags,
 303         [in] IWbemContext *pCtx,
 304         [in] IWbemObjectSink *pResponseHandler);
 305
 306     HRESULT PutInstance(
 307         [in] IWbemClassObject *pInst,
 308         [in] long lFlags,
 309         [in] IWbemContext *pCtx,
 310         [out] IWbemCallResult **ppCallResult);
 311
 312     HRESULT PutInstanceAsync(
 313         [in] IWbemClassObject *pInst,
 314         [in] long lFlags,
 315         [in] IWbemContext *pCtx,
 316         [in] IWbemObjectSink *pResponseHandler);
 317
 318     HRESULT DeleteInstance(
 319         [in] const BSTR strObjectPath,
 320         [in] long lFlags,
 321         [in] IWbemContext *pCtx,
 322         [out] IWbemCallResult **ppCallResult);
 323
 324     HRESULT DeleteInstanceAsync(
 325         [in] const BSTR strObjectPath,
 326         [in] long lFlags,
 327         [in] IWbemContext *pCtx,
 328         [in] IWbemObjectSink *pResponseHandler);
 329
 330     HRESULT CreateInstanceEnum(
 331         [in] const BSTR strFilter,
 332         [in] long lFlags,
 333         [in] IWbemContext *pCtx,
 334         [out] IEnumWbemClassObject **ppEnum);
 335
 336     HRESULT CreateInstanceEnumAsync(
 337         [in] const BSTR strFilter,
 338         [in] long lFlags,
 339         [in] IWbemContext *pCtx,
 340         [in] IWbemObjectSink *pResponseHandler);
 341
 342     HRESULT ExecQuery(
 343         [in] const BSTR strQueryLanguage,
 344         [in] const BSTR strQuery,
 345         [in] long lFlags,
 346         [in] IWbemContext *pCtx,
 347         [out] IEnumWbemClassObject **ppEnum);
 348
 349     HRESULT ExecQueryAsync(
 350         [in] const BSTR strQueryLanguage,
 351         [in] const BSTR strQuery,
 352         [in] long lFlags,
 353         [in] IWbemContext *pCtx,
 354         [in] IWbemObjectSink *pResponseHandler);
 355
 356     HRESULT ExecNotificationQuery(
 357         [in] const BSTR strQueryLanguage,
 358         [in] const BSTR strQuery,
 359         [in] long lFlags,
 360         [in] IWbemContext *pCtx,
 361         [out] IEnumWbemClassObject **ppEnum);
 362
 363     HRESULT ExecNotificationQueryAsync(
 364         [in] const BSTR strQueryLanguage,
 365         [in] const BSTR strQuery,
 366         [in] long lFlags,
 367         [in] IWbemContext *pCtx,
 368         [in] IWbemObjectSink *pResponseHandler);
 369
 370     HRESULT ExecMethod(
 371         [in] const BSTR strObjectPath,
 372         [in] const BSTR strMethodName,
 373         [in] long lFlags,
 374         [in] IWbemContext *pCtx,
 375         [in] IWbemClassObject *pInParams,
 376         [out] IWbemClassObject **ppOutParams,
 377         [out] IWbemCallResult **ppCallResult);
 378
 379     HRESULT ExecMethodAsync(
 380         [in] const BSTR strObjectPath,
 381         [in] const BSTR strMethodName,
 382         [in] long lFlags,
 383         [in] IWbemContext *pCtx,
 384         [in] IWbemClassObject *pInParams,
 385         [in] IWbemObjectSink *pResponseHandler);
 386 };
 387
 388 [
 389     object,
 390     restricted,
 391     uuid(027947e1-d731-11ce-a357-000000000001)
 392 ]
 393 interface IEnumWbemClassObject : IUnknown
 394 {
 395     HRESULT Reset();
 396
 397     HRESULT Next(
 398         [in] long lTimeout,
 399         [in] ULONG uCount,
 400         [out, size_is(uCount), length_is(*puReturned)] IWbemClassObject **apObjects,
 401         [out] ULONG *puReturned);
 402
 403     HRESULT NextAsync(
 404         [in] ULONG uCount,
 405         [in] IWbemObjectSink *pSink);
 406
 407     HRESULT Clone(
 408         [out] IEnumWbemClassObject **ppEnum);
 409
 410     HRESULT Skip(
 411         [in] long lTimeout,
 412         [in] ULONG nCount);
 413 };