include/ole32/obj_moniker.h

   1 /*
   2  * Defines the COM interfaces and APIs related to the moniker functionality.
   3  */
   4 #ifndef __WINE_WINE_OBJ_MONIKER_H
   5 #define __WINE_WINE_OBJ_MONIKER_H
   6
   7 #ifdef __cplusplus
   8 extern "C" {
   9 #endif /* defined(__cplusplus) */
  10
  11 /*****************************************************************************
  12  * Predeclare the interfaces
  13  */
  14 DEFINE_OLEGUID(IID_IBindCtx,0xe,0,0);
  15 typedef struct IBindCtx IBindCtx,*LPBINDCTX;
  16 typedef LPBINDCTX LPBC;
  17
  18 DEFINE_OLEGUID(IID_IClassActivator,     0x00000140L, 0, 0);
  19 typedef struct IClassActivator IClassActivator,*LPCLASSACTIVATOR;
  20
  21 DEFINE_OLEGUID(IID_IEnumMoniker,        0x00000102L, 0, 0);
  22 typedef struct IEnumMoniker IEnumMoniker,*LPENUMMONIKER;
  23
  24 DEFINE_OLEGUID(IID_IMoniker,            0x0000000fL, 0, 0);
  25 typedef struct IMoniker IMoniker,*LPMONIKER;
  26
  27 DEFINE_GUID   (IID_IROTData,            0xf29f6bc0L, 0x5021, 0x11ce, 0xaa, 0x15, 0x00, 0x00, 0x69, 0x01, 0x29, 0x3f);
  28 typedef struct IROTData IROTData,*LPROTDATA;
  29
  30 DEFINE_OLEGUID(IID_IRunnableObject,     0x00000126L, 0, 0);
  31 typedef struct IRunnableObject IRunnableObject,*LPRUNNABLEOBJECT;
  32
  33 DEFINE_OLEGUID(IID_IRunningObjectTable, 0x00000010L, 0, 0);
  34 typedef struct IRunningObjectTable IRunningObjectTable,*LPRUNNINGOBJECTTABLE;
  35
  36 DEFINE_GUID( CLSID_FileMoniker,0x00000303,0,0,0xc0,0,0,0,0,0,0,0x46);
  37
  38 DEFINE_GUID( CLSID_ItemMoniker,0x00000304,0,0,0xc0,0,0,0,0,0,0,0x46);
  39
  40 DEFINE_GUID( CLSID_AntiMoniker,0x00000305,0,0,0xc0,0,0,0,0,0,0,0x46);
  41
  42 DEFINE_GUID( CLSID_CompositeMoniker,0x00000309,0,0,0xc0,0,0,0,0,0,0,0x46);
  43
  44 /*********************************************************************************
  45  *      BIND_OPTS and BIND_OPTS2 structures definition
  46  *      These structures contain parameters used during a moniker-binding operation.
  47  *********************************************************************************/
  48 typedef struct tagBIND_OPTS
  49 {
  50     DWORD cbStruct;
  51     DWORD grfFlags;
  52     DWORD grfMode;
  53     DWORD dwTickCountDeadline;
  54 } BIND_OPTS, * LPBIND_OPTS;
  55
  56 typedef struct tagBIND_OPTS2
  57 {
  58     DWORD cbStruct;
  59     DWORD grfFlags;
  60     DWORD grfMode;
  61     DWORD dwTickCountDeadline;
  62     DWORD dwTrackFlags;
  63     DWORD dwClassContext;
  64     LCID  locale;
  65     COSERVERINFO* pServerInfo;
  66 } BIND_OPTS2, * LPBIND_OPTS2;
  67
  68 /*****************************************************************************
  69  * IBindCtx interface
  70  */
  71 #define ICOM_INTERFACE IBindCtx
  72 #define IBindCtx_METHODS \
  73     ICOM_METHOD1 (HRESULT, RegisterObjectBound,  IUnknown*,punk) \
  74     ICOM_METHOD1 (HRESULT, RevokeObjectBound,    IUnknown*,punk) \
  75     ICOM_METHOD  (HRESULT, ReleaseBoundObjects) \
  76     ICOM_METHOD1 (HRESULT, SetBindOptions,       LPBIND_OPTS2,pbindopts) \
  77     ICOM_METHOD1 (HRESULT, GetBindOptions,       LPBIND_OPTS2,pbindopts) \
  78     ICOM_METHOD1 (HRESULT, GetRunningObjectTable,IRunningObjectTable**,pprot) \
  79     ICOM_METHOD2 (HRESULT, RegisterObjectParam,  LPOLESTR,pszkey, IUnknown*,punk) \
  80     ICOM_METHOD2 (HRESULT, GetObjectParam,       LPOLESTR,pszkey, IUnknown**,punk) \
  81     ICOM_METHOD1 (HRESULT, EnumObjectParam,      IEnumString**,ppenum) \
  82     ICOM_METHOD1 (HRESULT, RevokeObjectParam,    LPOLESTR,pszkey)
  83 #define IBindCtx_IMETHODS \
  84     IUnknown_IMETHODS \
  85     IBindCtx_METHODS
  86 ICOM_DEFINE(IBindCtx,IUnknown)
  87 #undef ICOM_INTERFACE
  88
  89 /*** IUnknown methods ***/
  90 #define IBindCtx_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
  91 #define IBindCtxr_AddRef(p)            ICOM_CALL (AddRef,p)
  92 #define IBindCtx_Release(p)            ICOM_CALL (Release,p)
  93 /* IBindCtx methods*/
  94 #define IBindCtx_RegisterObjectBound(p,a)   ICOM_CALL1(RegisterObjectBound,p,a)
  95 #define IBindCtx_RevokeObjectBound(p,a)     ICOM_CALL1(RevokeObjectBound,p,a)
  96 #define IBindCtx_ReleaseBoundObjects(p)     ICOM_CALL (ReleaseBoundObjects,p)
  97 #define IBindCtx_SetBindOptions(p,a)        ICOM_CALL1(SetBindOptions,p,a)
  98 #define IBindCtx_GetBindOptions(p,a)        ICOM_CALL1(GetBindOptions,p,a)
  99 #define IBindCtx_GetRunningObjectTable(p,a) ICOM_CALL1(GetRunningObjectTable,p,a)
 100 #define IBindCtx_RegisterObjectParam(p,a,b) ICOM_CALL2(RegisterObjectParam,p,a,b)
 101 #define IBindCtx_GetObjectParam(p,a,b)      ICOM_CALL2(GetObjectParam,p,a,b)
 102 #define IBindCtx_EnumObjectParam(p,a)       ICOM_CALL1(EnumObjectParam,p,a)
 103 #define IBindCtx_RevokeObjectParam(p,a)     ICOM_CALL1(RevokeObjectParam,p,a)
 104
 105 HRESULT WINAPI CreateBindCtx16(DWORD reserved, LPBC* ppbc);
 106 HRESULT WINAPI CreateBindCtx(DWORD reserved, LPBC* ppbc);
 107
 108 /*****************************************************************************
 109  * IClassActivator interface
 110  */
 111 #define ICOM_INTERFACE IClassActivator
 112 #define IClassActivator_METHODS \
 113     ICOM_METHOD5(HRESULT,GetClassObject, REFCLSID,rclsid, DWORD,dwClassContext, LCID,locale, REFIID,riid, void**,ppv)
 114 #define IClassActivator_IMETHODS \
 115     IUnknown_IMETHODS \
 116     IClassActivator_METHODS
 117 ICOM_DEFINE(IClassActivator,IUnknown)
 118 #undef ICOM_INTERFACE
 119
 120 /*** IUnknown methods ***/
 121 #define IClassActivator_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
 122 #define IClassActivator_AddRef(p)             ICOM_CALL (AddRef,p)
 123 #define IClassActivator_Release(p)            ICOM_CALL (Release,p)
 124 /*** IClassActivator methods ***/
 125 #define IClassActivator_GetClassObject(p,a,b,c,d,e) ICOM_CALL5(GetClassObject,p,a,b,c,d,e)
 126
 127
 128 /*****************************************************************************
 129  * IEnumMoniker interface
 130  */
 131 #define ICOM_INTERFACE IEnumMoniker
 132 #define IEnumMoniker_METHODS \
 133     ICOM_METHOD3(HRESULT,Next,  ULONG,celt, IMoniker**,rgelt, ULONG*,pceltFethed) \
 134     ICOM_METHOD1(HRESULT,Skip,  ULONG,celt) \
 135     ICOM_METHOD (HRESULT,Reset) \
 136     ICOM_METHOD1(HRESULT,Clone, IEnumMoniker**,ppenum)
 137 #define IEnumMoniker_IMETHODS \
 138     IUnknown_IMETHODS \
 139     IEnumMoniker_METHODS
 140 ICOM_DEFINE(IEnumMoniker,IUnknown)
 141 #undef ICOM_INTERFACE
 142
 143 /*** IUnknown methods ***/
 144 #define IEnumMoniker_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
 145 #define IEnumMoniker_AddRef(p)             ICOM_CALL (AddRef,p)
 146 #define IEnumMoniker_Release(p)            ICOM_CALL (Release,p)
 147 /*** IEnumMoniker methods ***/
 148 #define IEnumMoniker_Next(p,a,b,c) ICOM_CALL3(Next,p,a,b,c)
 149 #define IEnumMoniker_Skip(p,a)     ICOM_CALL1(Skip,p,a)
 150 #define IEnumMoniker_Reset(p)      ICOM_CALL (Reset,p)
 151 #define IEnumMoniker_Clone(p,a)    ICOM_CALL1(Clone,p,a)
 152
 153 /*****************************************************************************
 154  * IMoniker interface
 155  */
 156
 157 typedef enum tagMKSYS
 158 {
 159     MKSYS_NONE              = 0,
 160     MKSYS_GENERICCOMPOSITE  = 1,
 161     MKSYS_FILEMONIKER       = 2,
 162     MKSYS_ANTIMONIKER       = 3,
 163     MKSYS_ITEMMONIKER       = 4,
 164     MKSYS_POINTERMONIKER    = 5,
 165     MKSYS_CLASSMONIKER      = 7
 166 } MKSYS;
 167
 168 typedef enum tagMKREDUCE
 169 {
 170     MKRREDUCE_ONE           = 3 << 16,
 171     MKRREDUCE_TOUSER        = 2 << 16,
 172     MKRREDUCE_THROUGHUSER   = 1 << 16,
 173     MKRREDUCE_ALL           = 0
 174 } MKRREDUCE;
 175
 176 #define ICOM_INTERFACE IMoniker
 177 #define IMoniker_METHODS \
 178     ICOM_METHOD4(HRESULT,BindToObject,        IBindCtx*,pbc, IMoniker*,pmkToLeft, REFIID,riidResult, void**,ppvResult) \
 179     ICOM_METHOD4(HRESULT,BindToStorage,       IBindCtx*,pbc, IMoniker*,pmkToLeft, REFIID,riid, void**,ppvObj) \
 180     ICOM_METHOD4(HRESULT,Reduce,              IBindCtx*,pbc, DWORD,dwReduceHowFar, IMoniker**,ppmkToLeft, IMoniker**,ppmkReduced) \
 181     ICOM_METHOD3(HRESULT,ComposeWith,         IMoniker*,pmkRight, BOOL,fOnlyIfNotGeneric, IMoniker**,ppmkComposite) \
 182     ICOM_METHOD2(HRESULT,Enum,                BOOL,fForward, IEnumMoniker**,ppenumMoniker) \
 183     ICOM_METHOD1(HRESULT,IsEqual,             IMoniker*,pmkOtherMoniker) \
 184     ICOM_METHOD1(HRESULT,Hash,                DWORD*,pdwHash) \
 185     ICOM_METHOD3(HRESULT,IsRunning,           IBindCtx*,pbc, IMoniker*,pmkToLeft, IMoniker*,pmkNewlyRunning) \
 186     ICOM_METHOD3(HRESULT,GetTimeOfLastChange, IBindCtx*,pbc, IMoniker*,pmkToLeft, FILETIME*,pFileTime) \
 187     ICOM_METHOD1(HRESULT,Inverse,             IMoniker**,ppmk) \
 188     ICOM_METHOD2(HRESULT,CommonPrefixWith,    IMoniker*,pmkOtherMoniker, IMoniker**,ppmkPrefix) \
 189     ICOM_METHOD2(HRESULT,RelativePathTo,      IMoniker*,pmkOther, IMoniker**,ppmkRelPath) \
 190     ICOM_METHOD3(HRESULT,GetDisplayName,      IBindCtx*,pbc, IMoniker*,pmkToLeft, LPOLESTR*,ppszDisplayName) \
 191     ICOM_METHOD5(HRESULT,ParseDisplayName,    IBindCtx*,pbc, IMoniker*,pmkToLeft, LPOLESTR,pszDisplayName, ULONG*,pchEaten, IMoniker**,ppmkOut) \
 192     ICOM_METHOD1(HRESULT,IsSystemMoniker,     DWORD*,pdwMksys)
 193 #define IMoniker_IMETHODS \
 194     IPersistStream_IMETHODS \
 195     IMoniker_METHODS
 196 ICOM_DEFINE(IMoniker,IPersistStream)
 197 #undef ICOM_INTERFACE
 198
 199 /*** IUnknown methods ***/
 200 #define IMoniker_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
 201 #define IMoniker_AddRef(p)             ICOM_CALL (AddRef,p)
 202 #define IMoniker_Release(p)            ICOM_CALL (Release,p)
 203
 204 /*** IPersist methods ***/
 205 #define IMoniker_GetClassID(p,a) ICOM_CALL1(GetClassID,p,a)
 206 /*** IPersistStream methods ***/
 207 #define IMoniker_IsDirty(p)      ICOM_CALL (IsDirty,p)
 208 #define IMoniker_Load(p,a)       ICOM_CALL1(Load,p,a)
 209 #define IMoniker_Save(p,a,b)     ICOM_CALL2(Save,p,a,b)
 210 #define IMoniker_GetSizeMax(p,a) ICOM_CALL1(GetSizeMax,p,a)
 211 /*** IMoniker methods ***/
 212 #define IMoniker_BindToObject(p,a,b,c,d)            ICOM_CALL4(BindToObject,p,a,b,c,d)
 213 #define IMoniker_BindToStorage(p,a,b,c,d)           ICOM_CALL4(BindToStorage,p,a,b,c,d)
 214 #define IMoniker_Reduce(p,a,b,c,d)                  ICOM_CALL4(Reduce,p,a,b,c,d)
 215 #define IMoniker_ComposeWith(p,a,b,c)               ICOM_CALL3(ComposeWith,p,a,b,c)
 216 #define IMoniker_Enum(p,a,b)                        ICOM_CALL2(Enum,p,a,b)
 217 #define IMoniker_IsEqual(p,a)                       ICOM_CALL1(IsEqual,p,a)
 218 #define IMoniker_Hash(p,a)                          ICOM_CALL1(Hash,p,a)
 219 #define IMoniker_IsRunning(p,a,b,c)                 ICOM_CALL3(IsRunning,p,a,b,c)
 220 #define IMoniker_GetTimeOfLastChange(p,a,b,c)       ICOM_CALL3(GetTimeOfLastChange,p,a,b,c)
 221 #define IMoniker_Inverse(p,a)                       ICOM_CALL1(Inverse,p,a)
 222 #define IMoniker_CommonPrefixWith(p,a,b)            ICOM_CALL2(CommonPrefixWith,p,a,b)
 223 #define IMoniker_RelativePathTo(p,a,b)              ICOM_CALL2(RelativePathTo,p,a,b)
 224 #define IMoniker_GetDisplayName(p,a,b,c)            ICOM_CALL3(GetDisplayName,p,a,b,c)
 225 #define IMoniker_ParseDisplayName(p,a,b,c,d,e)      ICOM_CALL5(ParseDisplayName,p,a,b,c,d,e)
 226 #define IMoniker_IsSystemMoniker(p,a)               ICOM_CALL1(IsSystemMoniker,p,a)
 227
 228 HRESULT WINAPI CreateFileMoniker16(LPCOLESTR16 lpszPathName, LPMONIKER* ppmk);
 229 HRESULT WINAPI CreateFileMoniker(LPCOLESTR lpszPathName, LPMONIKER* ppmk);
 230
 231 HRESULT WINAPI CreateItemMoniker16(LPCOLESTR16 lpszDelim, LPCOLESTR  lpszItem, LPMONIKER* ppmk);
 232 HRESULT WINAPI CreateItemMoniker(LPCOLESTR lpszDelim, LPCOLESTR  lpszItem, LPMONIKER* ppmk);
 233
 234 HRESULT WINAPI CreateAntiMoniker(LPMONIKER * ppmk);
 235
 236 HRESULT WINAPI CreateGenericComposite(LPMONIKER pmkFirst, LPMONIKER pmkRest, LPMONIKER* ppmkComposite);
 237
 238 /* FIXME: not implemented */
 239 HRESULT WINAPI  BindMoniker(LPMONIKER pmk, DWORD grfOpt, REFIID iidResult, LPVOID* ppvResult);
 240
 241 /* FIXME: not implemented */
 242 HRESULT WINAPI CreateClassMoniker(REFCLSID rclsid, LPMONIKER* ppmk);
 243
 244 /* FIXME: not implemented */
 245 HRESULT WINAPI CreatePointerMoniker(LPUNKNOWN punk, LPMONIKER* ppmk);
 246
 247 /* FIXME: not implemented */
 248 HRESULT WINAPI MonikerCommonPrefixWith(IMoniker* pmkThis,IMoniker* pmkOther,IMoniker** ppmkCommon);
 249 /*****************************************************************************
 250  * IROTData interface
 251  */
 252 #define ICOM_INTERFACE IROTData
 253 #define IROTData_METHODS \
 254     ICOM_METHOD3(HRESULT,GetComparisonData, BYTE*,pbData, ULONG,cbMax, ULONG*,pcbData)
 255 #define IROTData_IMETHODS \
 256     IUnknown_IMETHODS \
 257     IROTData_METHODS
 258 ICOM_DEFINE(IROTData,IUnknown)
 259 #undef ICOM_INTERFACE
 260
 261 /*** IUnknown methods ***/
 262 #define IROTData_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
 263 #define IROTData_AddRef(p)             ICOM_CALL (AddRef,p)
 264 #define IROTData_Release(p)            ICOM_CALL (Release,p)
 265 /*** IROTData methods ***/
 266 #define IROTData_GetComparisonData(p,a,b,c) ICOM_CALL3(GetComparisonData,p,a,b,c)
 267
 268 #define ICOM_THIS_From_IROTData(class, name) class* This = (class*)(((char*)name)-sizeof(void*))
 269
 270 /*****************************************************************************
 271  * IRunnableObject interface
 272  */
 273 #define ICOM_INTERFACE IRunnableObject
 274 #define IRunnableObject_METHODS \
 275     ICOM_METHOD1(HRESULT,GetRunningClass,    LPCLSID,lpClsid) \
 276     ICOM_METHOD1(HRESULT,Run,                IBindCtx*,pbc) \
 277     ICOM_METHOD (BOOL,IsRunning) \
 278     ICOM_METHOD2(HRESULT,LockRunning,        BOOL,fLock, BOOL,fLastUnlockCloses) \
 279     ICOM_METHOD1(HRESULT,SetContainedObject, BOOL,fContained)
 280 #define IRunnableObject_IMETHODS \
 281     IUnknown_IMETHODS \
 282     IRunnableObject_METHODS
 283 ICOM_DEFINE(IRunnableObject,IUnknown)
 284 #undef ICOM_INTERFACE
 285
 286 /*** IUnknown methods ***/
 287 #define IRunnableObject_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
 288 #define IRunnableObject_AddRef(p)             ICOM_CALL (AddRef,p)
 289 #define IRunnableObject_Release(p)            ICOM_CALL (Release,p)
 290 /*** IRunnableObject methods ***/
 291 #define IRunnableObject_GetRunningClass(p,a)    ICOM_CALL1(GetRunningClass,p,a)
 292 #define IRunnableObject_Run(p,a)                ICOM_CALL1(Run,p,a)
 293 #define IRunnableObject_IsRunning(p)            ICOM_CALL (IsRunning,p)
 294 #define IRunnableObject_LockRunning(p,a,b)      ICOM_CALL2(LockRunning,p,a,b)
 295 #define IRunnableObject_SetContainedObject(p,a) ICOM_CALL1(SetContainedObject,p,a)
 296
 297
 298 /*****************************************************************************
 299  * IRunningObjectTable interface
 300  */
 301 #ifdef __WINE__
 302 #undef GetObject
 303 #endif
 304
 305 #define ICOM_INTERFACE IRunningObjectTable
 306 #define IRunningObjectTable_METHODS \
 307     ICOM_METHOD4(HRESULT,Register,            DWORD,grfFlags, IUnknown*,punkObject, IMoniker*,pmkObjectName, DWORD*,pdwRegister) \
 308     ICOM_METHOD1(HRESULT,Revoke,              DWORD,dwRegister) \
 309     ICOM_METHOD1(HRESULT,IsRunning,           IMoniker*,pmkObjectName) \
 310     ICOM_METHOD2(HRESULT,GetObject,           IMoniker*,pmkObjectName, IUnknown**,ppunkObject) \
 311     ICOM_METHOD2(HRESULT,NoteChangeTime,      DWORD,dwRegister, FILETIME*,pfiletime) \
 312     ICOM_METHOD2(HRESULT,GetTimeOfLastChange, IMoniker*,pmkObjectName, FILETIME*,pfiletime) \
 313     ICOM_METHOD1(HRESULT,EnumRunning,         IEnumMoniker**,ppenumMoniker)
 314 #define IRunningObjectTable_IMETHODS \
 315     IUnknown_IMETHODS \
 316     IRunningObjectTable_METHODS
 317 ICOM_DEFINE(IRunningObjectTable,IUnknown)
 318 #undef ICOM_INTERFACE
 319
 320 /*** IUnknown methods ***/
 321 #define IRunningObjectTable_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
 322 #define IRunningObjectTable_AddRef(p)             ICOM_CALL (AddRef,p)
 323 #define IRunningObjectTable_Release(p)            ICOM_CALL (Release,p)
 324 /*** IRunningObjectTable methods ***/
 325 #define IRunningObjectTable_Register(p,a,b,c,d)        ICOM_CALL4(Register,p,a,b,c,d)
 326 #define IRunningObjectTable_Revoke(p,a)                ICOM_CALL1(Revoke,p,a)
 327 #define IRunningObjectTable_IsRunning(p,a)             ICOM_CALL1(IsRunning,p,a)
 328 #define IRunningObjectTable_GetObject(p,a,b)           ICOM_CALL2(GetObject,p,a,b)
 329 #define IRunningObjectTable_NoteChangeTime(p,a,b)      ICOM_CALL2(NoteChangeTime,p,a,b)
 330 #define IRunningObjectTable_GetTimeOfLastChange(p,a,b) ICOM_CALL2(GetTimeOfLastChange,p,a,b)
 331 #define IRunningObjectTable_EnumRunning(p,a)           ICOM_CALL1(EnumRunning,p,a)
 332
 333 HRESULT WINAPI GetRunningObjectTable(DWORD reserved, LPRUNNINGOBJECTTABLE *pprot);
 334 HRESULT WINAPI GetRunningObjectTable16(DWORD reserved, LPRUNNINGOBJECTTABLE *pprot);
 335
 336 /*****************************************************************************
 337  * Additional API
 338  */
 339
 340 /* FIXME: not implemented */
 341 HRESULT WINAPI CoGetInstanceFromFile(COSERVERINFO* pServerInfo, CLSID* pClsid, IUnknown* punkOuter, DWORD dwClsCtx, DWORD grfMode, OLECHAR* pwszName, DWORD dwCount, MULTI_QI* pResults);
 342
 343 /* FIXME: not implemented */
 344 HRESULT WINAPI CoGetInstanceFromIStorage(COSERVERINFO* pServerInfo, CLSID* pClsid, IUnknown* punkOuter, DWORD dwClsCtx, IStorage* pstg, DWORD dwCount, MULTI_QI* pResults);
 345
 346 #ifdef __cplusplus
 347 } /* extern "C" */
 348 #endif /* defined(__cplusplus) */
 349
 350 #endif /* __WINE_WINE_OBJ_MONIKER_H */