1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
#pragma once
// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
#define BAAPI HRESULT __stdcall
#if defined(__cplusplus)
extern "C" {
#endif
// constants
const DWORD BURN_MB_RETRYTRYAGAIN = 0x10;
const DWORD64 BOOTSTRAPPER_APPLICATION_API_VERSION = MAKEQWORDVERSION(2024, 1, 1, 0);
// structs
typedef struct _BURN_USER_EXPERIENCE
{
BURN_PAYLOADS payloads;
BURN_PAYLOAD* pPrimaryExePayload;
BURN_PAYLOAD* pSecondaryExePayload;
//HMODULE hUXModule;
//PFN_BOOTSTRAPPER_APPLICATION_PROC pfnBAProc;
//LPVOID pvBAProcContext;
HANDLE hBAProcess;
PIPE_RPC_HANDLE hBARpcPipe;
BAENGINE_CONTEXT* pEngineContext;
LPWSTR sczTempDirectory;
CRITICAL_SECTION csEngineActive; // Changing the engine active state in the user experience must be
// syncronized through this critical section.
// Note: The engine must never do a UX callback while in this critical section.
BOOL fEngineActive; // Indicates that the engine is currently active with one of the execution
// steps (detect, plan, apply), and cannot accept requests from the UX.
// This flag should be cleared by the engine prior to UX callbacks that
// allow altering of the engine state.
HRESULT hrApplyError; // Tracks if an error occurs during apply that requires the cache or
// execute threads to bail.
HWND hwndApply; // The window handle provided at the beginning of Apply(). Only valid
// during apply.
HWND hwndDetect; // The window handle provided at the beginning of Detect(). Only valid
// during Detect.
DWORD dwExitCode; // Exit code returned by the user experience for the engine overall.
} BURN_USER_EXPERIENCE;
// functions
/*******************************************************************
BootstrapperApplicationParseFromXml - parses the bootstrapper application
data embedded in the bundle.
*******************************************************************/
HRESULT BootstrapperApplicationParseFromXml(
__in BURN_USER_EXPERIENCE* pUserExperience,
__in IXMLDOMNode* pixnBundle
);
/*******************************************************************
BootstrapperApplicationUninitialize - uninitializes the bootstrapper
application data.
*******************************************************************/
void BootstrapperApplicationUninitialize(
__in BURN_USER_EXPERIENCE* pUserExperience
);
/*******************************************************************
BootstrapperApplicationStart - starts the bootstrapper application
process and creates the bootstrapper application in it.
*******************************************************************/
HRESULT BootstrapperApplicationStart(
__in BURN_ENGINE_STATE* pEngineState,
__in BOOL fSecondary
);
/*******************************************************************
BootstrapperApplicationStop - destroys the bootstrapper application
in the bootstrapper application process, disconnects and waits
for the process to exit.
*******************************************************************/
HRESULT BootstrapperApplicationStop(
__in BURN_USER_EXPERIENCE* pUserExperience,
__inout BOOL* pfReload
);
int BootstrapperApplicationCheckExecuteResult(
__in BURN_USER_EXPERIENCE* pUserExperience,
__in BOOL fRollback,
__in DWORD dwAllowedResults,
__in int nResult
);
HRESULT BootstrapperApplicationInterpretExecuteResult(
__in BURN_USER_EXPERIENCE* pUserExperience,
__in BOOL fRollback,
__in DWORD dwAllowedResults,
__in int nResult
);
HRESULT BootstrapperApplicationEnsureWorkingFolder(
__in BOOL fElevated,
__in BURN_CACHE* pCache,
__deref_out_z LPWSTR* psczUserExperienceWorkingFolder
);
HRESULT BootstrapperApplicationRemove(
__in BURN_USER_EXPERIENCE* pUserExperience
);
int BootstrapperApplicationSendError(
__in BURN_USER_EXPERIENCE* pUserExperience,
__in BOOTSTRAPPER_ERROR_TYPE errorType,
__in_z_opt LPCWSTR wzPackageId,
__in HRESULT hrCode,
__in_z_opt LPCWSTR wzError,
__in DWORD uiFlags,
__in int nRecommendation
);
void BootstrapperApplicationActivateEngine(
__in BURN_USER_EXPERIENCE* pUserExperience
);
void BootstrapperApplicationDeactivateEngine(
__in BURN_USER_EXPERIENCE* pUserExperience
);
/********************************************************************
BootstrapperApplicationEnsureEngineInactive - Verifies the engine is inactive.
The caller MUST enter the csActive critical section before calling.
*********************************************************************/
HRESULT BootstrapperApplicationEnsureEngineInactive(
__in BURN_USER_EXPERIENCE* pUserExperience
);
void BootstrapperApplicationExecuteReset(
__in BURN_USER_EXPERIENCE* pUserExperience
);
void BootstrapperApplicationExecutePhaseComplete(
__in BURN_USER_EXPERIENCE* pUserExperience,
__in HRESULT hrResult
);
#if defined(__cplusplus)
}
#endif
|
