aboutsummaryrefslogtreecommitdiff
path: root/src/balutil/inc/IBootstrapperApplication.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/balutil/inc/IBootstrapperApplication.h')
-rw-r--r--src/balutil/inc/IBootstrapperApplication.h50
1 files changed, 34 insertions, 16 deletions
diff --git a/src/balutil/inc/IBootstrapperApplication.h b/src/balutil/inc/IBootstrapperApplication.h
index ed70d8fe..8fcdd318 100644
--- a/src/balutil/inc/IBootstrapperApplication.h
+++ b/src/balutil/inc/IBootstrapperApplication.h
@@ -21,6 +21,7 @@ DECLARE_INTERFACE_IID_(IBootstrapperApplication, IUnknown, "53C31D56-49C0-426B-A
21 21
22 // OnDetectBegin - called when the engine begins detection. 22 // OnDetectBegin - called when the engine begins detection.
23 STDMETHOD(OnDetectBegin)( 23 STDMETHOD(OnDetectBegin)(
24 __in BOOL fCached,
24 __in BOOL fInstalled, 25 __in BOOL fInstalled,
25 __in DWORD cPackages, 26 __in DWORD cPackages,
26 __inout BOOL* pfCancel 27 __inout BOOL* pfCancel
@@ -279,14 +280,20 @@ DECLARE_INTERFACE_IID_(IBootstrapperApplication, IUnknown, "53C31D56-49C0-426B-A
279 __inout BOOL* pfCancel 280 __inout BOOL* pfCancel
280 ) = 0; 281 ) = 0;
281 282
282 // OnCacheAcquireBegin - called when the engine begins copying or 283 // OnCacheAcquireBegin - called when the engine begins acquiring a payload or container.
283 // downloading a payload to the working folder. 284 //
285 // Notes:
286 // It is expected the BA may call IBootstrapperEngine::SetLocalSource() or IBootstrapperEngine::SetDownloadSource()
287 // to update the source location before returning.
284 // 288 //
285 STDMETHOD(OnCacheAcquireBegin)( 289 STDMETHOD(OnCacheAcquireBegin)(
286 __in_z_opt LPCWSTR wzPackageOrContainerId, 290 __in_z_opt LPCWSTR wzPackageOrContainerId,
287 __in_z_opt LPCWSTR wzPayloadId, 291 __in_z_opt LPCWSTR wzPayloadId,
288 __in BOOTSTRAPPER_CACHE_OPERATION operation,
289 __in_z LPCWSTR wzSource, 292 __in_z LPCWSTR wzSource,
293 __in_z_opt LPCWSTR wzDownloadUrl,
294 __in_z_opt LPCWSTR wzPayloadContainerId,
295 __in BOOTSTRAPPER_CACHE_OPERATION recommendation,
296 __inout BOOTSTRAPPER_CACHE_OPERATION* pAction,
290 __inout BOOL* pfCancel 297 __inout BOOL* pfCancel
291 ) = 0; 298 ) = 0;
292 299
@@ -302,27 +309,38 @@ DECLARE_INTERFACE_IID_(IBootstrapperApplication, IUnknown, "53C31D56-49C0-426B-A
302 __inout BOOL* pfCancel 309 __inout BOOL* pfCancel
303 ) = 0; 310 ) = 0;
304 311
305 // OnResolveSource - called when a payload or container cannot be found locally. 312 // OnCacheAcquireResolving - called to allow the BA to override the acquisition action for the payload or container.
306 // 313 //
307 // Parameters: 314 // Parameters:
315 // wzPackageOrContainerId will be NULL when resolving a layout-only payload.
308 // wzPayloadId will be NULL when resolving a container. 316 // wzPayloadId will be NULL when resolving a container.
309 // wzDownloadSource will be NULL if the container or payload does not provide a DownloadURL. 317 // wzDownloadUrl will be NULL if the container or payload does not provide a DownloadURL.
318 // wzPayloadContainerId will not be NULL if acquiring a payload that is in a container.
310 // 319 //
311 // Notes: 320 // rgSearchPaths are the search paths used for source resolution.
312 // It is expected the BA may call IBootstrapperEngine::SetLocalSource() or IBootstrapperEngine::SetDownloadSource() 321 // fFoundLocal is TRUE when dwRecommendedSearchPath indicates that the file was found.
313 // to update the source location before returning BOOTSTRAPPER_RESOLVESOURCE_ACTION_RETRY or BOOTSTRAPPER_RESOLVESOURCE_ACTION_DOWNLOAD. 322 // dwRecommendedSearchPath is the index into rgSearchPaths for the recommended local file.
314 STDMETHOD(OnResolveSource)( 323 //
315 __in_z LPCWSTR wzPackageOrContainerId, 324 STDMETHOD(OnCacheAcquireResolving)(
325 __in_z_opt LPCWSTR wzPackageOrContainerId,
316 __in_z_opt LPCWSTR wzPayloadId, 326 __in_z_opt LPCWSTR wzPayloadId,
317 __in_z LPCWSTR wzLocalSource, 327 __in_z LPCWSTR* rgSearchPaths,
318 __in_z_opt LPCWSTR wzDownloadSource, 328 __in DWORD cSearchPaths,
319 __in BOOTSTRAPPER_RESOLVESOURCE_ACTION recommendation, 329 __in BOOL fFoundLocal,
320 __inout BOOTSTRAPPER_RESOLVESOURCE_ACTION* pAction, 330 __in DWORD dwRecommendedSearchPath,
331 __in_z_opt LPCWSTR wzDownloadUrl,
332 __in_z_opt LPCWSTR wzPayloadContainerId,
333 __in BOOTSTRAPPER_CACHE_RESOLVE_OPERATION recommendation,
334 __inout DWORD* pdwChosenSearchPath,
335 __inout BOOTSTRAPPER_CACHE_RESOLVE_OPERATION* pAction,
321 __inout BOOL* pfCancel 336 __inout BOOL* pfCancel
322 ) = 0; 337 ) = 0;
323 338
324 // OnCacheAcquireComplete - called after the engine copied or downloaded 339 // OnCacheAcquireComplete - called after the engine acquired the payload or container.
325 // a payload to the working folder. 340 //
341 // Notes:
342 // It is expected the BA may call IBootstrapperEngine::SetLocalSource() or IBootstrapperEngine::SetDownloadSource()
343 // to update the source location before returning BOOTSTRAPPER_CACHEACQUIRECOMPLETE_ACTION_RETRY.
326 // 344 //
327 STDMETHOD(OnCacheAcquireComplete)( 345 STDMETHOD(OnCacheAcquireComplete)(
328 __in_z_opt LPCWSTR wzPackageOrContainerId, 346 __in_z_opt LPCWSTR wzPackageOrContainerId,