ReactOS  0.4.14-dev-98-gb0d4763
bits.idl
Go to the documentation of this file.
1 /*
2  * Background Intelligent Transfer Service (BITS) interface
3  *
4  * Copyright 2007 Google (Roy Shea)
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  *
20  */
21 
22 #ifndef DO_NO_IMPORTS
23 import "unknwn.idl";
24 #endif
25 
26 cpp_quote("#include \"bitsmsg.h\"")
27 cpp_quote("#define BG_SIZE_UNKNOWN (UINT64)(-1)")
28 cpp_quote("#define BG_NOTIFY_JOB_TRANSFERRED 0x0001")
29 cpp_quote("#define BG_NOTIFY_JOB_ERROR 0x0002")
30 cpp_quote("#define BG_NOTIFY_DISABLE 0x0004")
31 cpp_quote("#define BG_NOTIFY_JOB_MODIFICATION 0x0008")
32 cpp_quote("#define BG_NOTIFY_FILE_TRANSFERRED 0x0010")
33 
34 cpp_quote("#ifdef WINE_NO_UNICODE_MACROS")
35 cpp_quote("#undef EnumJobs")
36 cpp_quote("#undef GetJob")
37 cpp_quote("#endif")
38 
39 #define BG_ENUM_SIZEIS(maxcount) maxcount
40 #define BG_ENUM_LENGTHIS(maxcount,lengthptr) lengthptr ? *lengthptr : maxcount
41 
42 [
43  uuid(01b7bd23-fb88-4a77-8490-5891d3e4653a),
44  odl
45 ]
47 {
48  typedef struct _BG_FILE_PROGRESS {
53 
55  [out] LPWSTR *pVal
56  );
57 
59  [out] LPWSTR *pVal
60  );
61 
63  [out] BG_FILE_PROGRESS *pVal
64  );
65 }
66 
67 
68 [
69  uuid(ca51e165-c365-424c-8d41-24aaa4ff3c40),
70  odl
71 ]
73 {
74  HRESULT Next(
75  [in] ULONG celt,
76  [out,size_is(BG_ENUM_SIZEIS(celt)),length_is(BG_ENUM_LENGTHIS(celt,pceltFetched))] IBackgroundCopyFile **rgelt,
77  [in,out,unique] ULONG *pceltFetched
78  );
79 
80  HRESULT Skip(
81  [in] ULONG celt
82  );
83 
84  HRESULT Reset();
85 
86  HRESULT Clone(
87  [out] IEnumBackgroundCopyFiles **ppenum
88  );
89 
91  [out] ULONG *puCount
92  );
93 }
94 
95 
96 [
97  uuid(19c613a0-fcb8-4f28-81ae-897c3d078f81),
98  odl
99 ]
101 {
102  typedef enum {
112 
114  [out,ref] BG_ERROR_CONTEXT *pContext,
115  [out,ref] HRESULT *pCode
116  );
117 
119  [out] IBackgroundCopyFile **pVal
120  );
121 
123  [in] DWORD LanguageId,
124  [out,ref] LPWSTR *pErrorDescription
125  );
126 
128  [in] DWORD LanguageId,
129  [out,ref] LPWSTR *pContextDescription
130  );
131 
133  [out,ref] LPWSTR *pProtocol
134  );
135 }
136 
137 
138 
139 [
140  uuid(37668d37-507e-4160-9316-26306d150b12),
141  odl
142 ]
144 {
145  typedef struct _BG_FILE_INFO {
148  } BG_FILE_INFO;
149 
150  typedef struct _BG_JOB_PROGRESS {
155  } BG_JOB_PROGRESS;
156 
157  typedef struct _BG_JOB_TIMES {
161  } BG_JOB_TIMES;
162 
163  typedef enum {
168  } BG_JOB_PRIORITY;
169 
170  typedef enum {
180  } BG_JOB_STATE;
181 
182  typedef enum {
186  } BG_JOB_TYPE;
187 
188  typedef enum {
194 
195 
197  [in] ULONG cFileCount,
198  [in,size_is(cFileCount)] BG_FILE_INFO *pFileSet
199  );
200 
202  [in] LPCWSTR RemoteUrl,
203  [in] LPCWSTR LocalName
204  );
205 
207  [out] IEnumBackgroundCopyFiles **pEnum
208  );
209 
210  HRESULT Suspend();
211 
212  HRESULT Resume();
213 
214  HRESULT Cancel();
215 
216  HRESULT Complete();
217 
218  HRESULT GetId(
219  [out] GUID *pVal
220  );
221 
223  [out] BG_JOB_TYPE *pVal
224  );
225 
227  [out] BG_JOB_PROGRESS *pVal
228  );
229 
231  [out] BG_JOB_TIMES *pVal
232  );
233 
235  [out] BG_JOB_STATE *pVal
236  );
237 
239  [out] IBackgroundCopyError **ppError
240  );
241 
243  [out] LPWSTR *pVal
244  );
245 
247  [in] LPCWSTR Val
248  );
249 
251  [out] LPWSTR *pVal
252  );
253 
255  [in] LPCWSTR Val
256  );
257 
259  [out] LPWSTR *pVal
260  );
261 
263  [in] BG_JOB_PRIORITY Val
264  );
265 
267  [out] BG_JOB_PRIORITY *pVal
268  );
269 
271  [in] ULONG Val
272  );
273 
275  [out] ULONG *pVal
276  );
277 
279  [in] IUnknown *Val
280  );
281 
283  [out] IUnknown ** pVal
284  );
285 
287  [in] ULONG Seconds
288  );
289 
291  [out] ULONG *Seconds
292  );
293 
295  [in] ULONG Seconds
296  );
297 
299  [out] ULONG *Seconds
300  );
301 
303  [out] ULONG *Errors
304  );
305 
307  [in] BG_JOB_PROXY_USAGE ProxyUsage,
308  [in,string,unique] const WCHAR *ProxyList,
309  [in,string,unique] const WCHAR *ProxyBypassList
310  );
311 
313  [out] BG_JOB_PROXY_USAGE *pProxyUsage,
314  [out] LPWSTR *pProxyList,
315  [out] LPWSTR *pProxyBypassList
316  );
317 
319 }
320 
321 [
322  uuid(1af4f612-3b71-466f-8f58-7b6f73ac57ad),
323  odl
324 ]
326 {
327  HRESULT Next(
328  [in] ULONG celt,
329  [out,size_is(BG_ENUM_SIZEIS(celt)),length_is(BG_ENUM_LENGTHIS(celt,pceltFetched))] IBackgroundCopyJob **rgelt,
330  [in,out,unique] ULONG *pceltFetched
331  );
332 
333  HRESULT Skip(
334  [in] ULONG celt
335  );
336 
337  HRESULT Reset();
338 
339  HRESULT Clone(
340  [out] IEnumBackgroundCopyJobs **ppenum
341  );
342 
344  [out] ULONG *puCount
345  );
346 }
347 
348 
349 [
350  uuid(97ea99c7-0186-4ad4-8df9-c5b4e0ed6b22),
351  odl
352 ]
354 {
356  [in] IBackgroundCopyJob *pJob
357  );
358 
360  [in] IBackgroundCopyJob *pJob,
361  [in] IBackgroundCopyError *pError
362  );
363 
365  [in] IBackgroundCopyJob *pJob,
367  );
368 }
369 
370 [
371  uuid(5ce34c0d-0dc9-4c1f-897c-daa1b78cee7c),
372  odl
373 ]
375 {
376  cpp_quote("#define BG_JOB_ENUM_ALL_USERS 0x0001")
377 
379  [in] LPCWSTR DisplayName,
380  [in] BG_JOB_TYPE Type,
381  [out] GUID *pJobId,
382  [out] IBackgroundCopyJob **ppJob
383  );
384 
385  HRESULT GetJob(
386  [in] REFGUID jobID,
387  [out] IBackgroundCopyJob **ppJob
388  );
389 
391  [in] DWORD dwFlags,
392  [out] IEnumBackgroundCopyJobs **ppEnum
393  );
395  [in] HRESULT hResult,
396  [in] DWORD LanguageId,
397  [out] LPWSTR *pErrorDescription);
398 }
399 
400 
401 [
402  uuid(1deeb74f-7915-4560-b558-918c83f176a6),
403  version(1.0)
404 ]
406 {
407  [
408  uuid(4991d34b-80a1-4291-83b6-3328366b9097),
409  ]
411  {
412  [default] interface IBackgroundCopyManager;
413  };
414 
415  interface IBackgroundCopyCallback;
416 }
417 
418 cpp_quote("#include \"bits1_5.h\"")
HRESULT GetMinimumRetryDelay([out] ULONG *Seconds)
HRESULT GetError([out, ref] BG_ERROR_CONTEXT *pContext, [out, ref] HRESULT *pCode)
HRESULT GetNoProgressTimeout([out] ULONG *Seconds)
#define BG_ENUM_LENGTHIS(maxcount, lengthptr)
Definition: bits.idl:40
struct IBackgroundCopyJob::_BG_JOB_TIMES BG_JOB_TIMES
Type
Definition: Type.h:6
HRESULT SetNotifyInterface([in] IUnknown *Val)
Definition: scsiwmi.h:51
const WCHAR * LPCWSTR
Definition: xmlstorage.h:185
HRESULT GetError([out] IBackgroundCopyError **ppError)
HRESULT JobError([in] IBackgroundCopyJob *pJob, [in] IBackgroundCopyError *pError)
HRESULT TakeOwnership()
HRESULT GetNotifyInterface([out] IUnknown **pVal)
HRESULT GetLocalName([out] LPWSTR *pVal)
HRESULT JobTransferred([in] IBackgroundCopyJob *pJob)
HRESULT JobModification([in] IBackgroundCopyJob *pJob, [in] DWORD dwReserved)
HRESULT SetPriority([in] BG_JOB_PRIORITY Val)
HRESULT GetNotifyFlags([out] ULONG *pVal)
HRESULT GetDescription([out] LPWSTR *pVal)
HRESULT GetDisplayName([out] LPWSTR *pVal)
FT_Library library
Definition: cffdrivr.c:654
HRESULT Clone([out] IEnumBackgroundCopyJobs **ppenum)
Definition: send.c:47
HRESULT Next([in] ULONG celt, [out, size_is(BG_ENUM_SIZEIS(celt)), length_is(BG_ENUM_LENGTHIS(celt, pceltFetched))] IBackgroundCopyFile **rgelt, [in, out, unique] ULONG *pceltFetched)
coclass AMMultiMediaStream cpp_quote("DEFINE_GUID(CLSID_AMDirectDrawStream, 0x49c47ce4, 0x9ba4, 0x11d0, 0x82, 0x12, 0x00, 0xc0, 0x4f, 0xc3, 0x2c, 0x45);") cpp_quote("DEFINE_GUID(CLSID_AMAudioStream
HRESULT AddFileSet([in] ULONG cFileCount, [in, size_is(cFileCount)] BG_FILE_INFO *pFileSet)
HRESULT EnumFiles([out] IEnumBackgroundCopyFiles **pEnum)
HRESULT SetNotifyFlags([in] ULONG Val)
struct IBackgroundCopyJob::_BG_JOB_PROGRESS BG_JOB_PROGRESS
_In_ HANDLE _In_ DWORD _In_ DWORD _Inout_opt_ LPOVERLAPPED _In_opt_ LPTRANSMIT_FILE_BUFFERS _In_ DWORD dwReserved
Definition: mswsock.h:90
unsigned int BOOL
Definition: ntddk_ex.h:94
#define e
Definition: ke_i.h:82
HRESULT SetMinimumRetryDelay([in] ULONG Seconds)
HRESULT GetJob([in] REFGUID jobID, [out] IBackgroundCopyJob **ppJob)
HRESULT EnumJobs([in] DWORD dwFlags, [out] IEnumBackgroundCopyJobs **ppEnum)
static const WCHAR version[]
Definition: asmname.c:64
HRESULT GetProgress([out] BG_JOB_PROGRESS *pVal)
HRESULT GetFile([out] IBackgroundCopyFile **pVal)
HRESULT GetProtocol([out, ref] LPWSTR *pProtocol)
HRESULT GetErrorContextDescription([in] DWORD LanguageId, [out, ref] LPWSTR *pContextDescription)
HRESULT GetCount([out] ULONG *puCount)
HRESULT GetState([out] BG_JOB_STATE *pVal)
GLfloat f
Definition: glext.h:7540
HRESULT AddFile([in] LPCWSTR RemoteUrl, [in] LPCWSTR LocalName)
__wchar_t WCHAR
Definition: xmlstorage.h:180
LONG HRESULT
Definition: typedefs.h:77
#define BG_ENUM_SIZEIS(maxcount)
Definition: bits.idl:39
HRESULT SetNoProgressTimeout([in] ULONG Seconds)
HRESULT Skip([in] ULONG celt)
HRESULT GetProgress([out] BG_FILE_PROGRESS *pVal)
HRESULT GetErrorDescription([in] DWORD LanguageId, [out, ref] LPWSTR *pErrorDescription)
const GLubyte * c
Definition: glext.h:8905
HRESULT SetDescription([in] LPCWSTR Val)
static FILE * out
Definition: regtests2xml.c:44
unsigned long DWORD
Definition: ntddk_ex.h:95
coclass TestTypelib::Coclass3 odl
HRESULT GetOwner([out] LPWSTR *pVal)
HRESULT GetRemoteName([out] LPWSTR *pVal)
_In_ PCCERT_CONTEXT _In_ DWORD dwFlags
Definition: wincrypt.h:1175
HRESULT GetPriority([out] BG_JOB_PRIORITY *pVal)
BG_JOB_ENUM_ALL_USERS HRESULT CreateJob([in] LPCWSTR DisplayName, [in] BG_JOB_TYPE Type, [out] GUID *pJobId, [out] IBackgroundCopyJob **ppJob)
HRESULT GetCount([out] ULONG *puCount)
HRESULT Next([in] ULONG celt, [out, size_is(BG_ENUM_SIZEIS(celt)), length_is(BG_ENUM_LENGTHIS(celt, pceltFetched))] IBackgroundCopyJob **rgelt, [in, out, unique] ULONG *pceltFetched)
GLuint in
Definition: glext.h:9616
HRESULT GetProxySettings([out] BG_JOB_PROXY_USAGE *pProxyUsage, [out] LPWSTR *pProxyList, [out] LPWSTR *pProxyBypassList)
HRESULT GetId([out] GUID *pVal)
HRESULT GetErrorCount([out] ULONG *Errors)
struct IBackgroundCopyFile::_BG_FILE_PROGRESS BG_FILE_PROGRESS
HRESULT Skip([in] ULONG celt)
HRESULT GetTimes([out] BG_JOB_TIMES *pVal)
unsigned int ULONG
Definition: retypes.h:1
struct IBackgroundCopyJob::_BG_FILE_INFO BG_FILE_INFO
HRESULT SetDisplayName([in] LPCWSTR Val)
static const struct update_accum a1
Definition: msg.c:578
unsigned long long UINT64
WCHAR * LPWSTR
Definition: xmlstorage.h:184
static const struct token_string Errors[]
Definition: error.c:42
HRESULT GetType([out] BG_JOB_TYPE *pVal)
HRESULT SetProxySettings([in] BG_JOB_PROXY_USAGE ProxyUsage, [in, string, unique] const WCHAR *ProxyList, [in, string, unique] const WCHAR *ProxyBypassList)
HRESULT GetErrorDescription([in] HRESULT hResult, [in] DWORD LanguageId, [out] LPWSTR *pErrorDescription)
HRESULT Clone([out] IEnumBackgroundCopyFiles **ppenum)