aboutsummaryrefslogtreecommitdiff
path: root/src/api/burn/balutil/inc/balutil.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/api/burn/balutil/inc/balutil.h')
-rw-r--r--src/api/burn/balutil/inc/balutil.h83
1 files changed, 83 insertions, 0 deletions
diff --git a/src/api/burn/balutil/inc/balutil.h b/src/api/burn/balutil/inc/balutil.h
index fad8a471..82fd1fe5 100644
--- a/src/api/burn/balutil/inc/balutil.h
+++ b/src/api/burn/balutil/inc/balutil.h
@@ -79,6 +79,27 @@ DAPI_(HRESULT) BalEvaluateCondition(
79 ); 79 );
80 80
81/******************************************************************* 81/*******************************************************************
82BalEscapeString - escapes a string to use as part of a formatted string variable.
83
84 Note: Use StrFree() to release psczOut.
85********************************************************************/
86DAPI_(HRESULT) BalEscapeString(
87 __in_z LPCWSTR wzIn,
88 __inout LPWSTR* psczOut
89 );
90
91/*******************************************************************
92BalEscapeStringFromEngine - escapes a string to use as part of a formatted string variable.
93
94 Note: Use StrFree() to release psczOut.
95********************************************************************/
96DAPI_(HRESULT) BalEscapeStringFromEngine(
97 __in IBootstrapperEngine* pEngine,
98 __in_z LPCWSTR wzIn,
99 __inout LPWSTR* psczOut
100 );
101
102/*******************************************************************
82BalFormatString - formats a string using variables in the engine. 103BalFormatString - formats a string using variables in the engine.
83 104
84 Note: Use StrFree() to release psczOut. 105 Note: Use StrFree() to release psczOut.
@@ -89,6 +110,17 @@ DAPI_(HRESULT) BalFormatString(
89 ); 110 );
90 111
91/******************************************************************* 112/*******************************************************************
113BalFormatStringFromEngine - formats a string using variables in the engine.
114
115 Note: Use StrFree() to release psczOut.
116********************************************************************/
117DAPI_(HRESULT) BalFormatStringFromEngine(
118 __in IBootstrapperEngine* pEngine,
119 __in_z LPCWSTR wzFormat,
120 __inout LPWSTR* psczOut
121 );
122
123/*******************************************************************
92BalGetNumericVariable - gets a number from a variable in the engine. 124BalGetNumericVariable - gets a number from a variable in the engine.
93 125
94 Note: Returns E_NOTFOUND if variable does not exist. 126 Note: Returns E_NOTFOUND if variable does not exist.
@@ -116,6 +148,15 @@ DAPI_(BOOL) BalVariableExists(
116 ); 148 );
117 149
118/******************************************************************* 150/*******************************************************************
151BalVariableExistsFromEngine - checks if a variable exists in the engine.
152
153********************************************************************/
154DAPI_(BOOL) BalVariableExistsFromEngine(
155 __in IBootstrapperEngine* pEngine,
156 __in_z LPCWSTR wzVariable
157 );
158
159/*******************************************************************
119BalGetStringVariable - gets a string from a variable in the engine. 160BalGetStringVariable - gets a string from a variable in the engine.
120 161
121 Note: Use StrFree() to release psczValue. 162 Note: Use StrFree() to release psczValue.
@@ -126,7 +167,19 @@ DAPI_(HRESULT) BalGetStringVariable(
126 ); 167 );
127 168
128/******************************************************************* 169/*******************************************************************
170BalGetStringVariableFromEngine - gets a string from a variable in the engine.
171
172 Note: Use StrFree() to release psczValue.
173********************************************************************/
174DAPI_(HRESULT) BalGetStringVariableFromEngine(
175 __in IBootstrapperEngine* pEngine,
176 __in_z LPCWSTR wzVariable,
177 __inout LPWSTR* psczValue
178 );
179
180/*******************************************************************
129BalSetStringVariable - sets a string variable in the engine. 181BalSetStringVariable - sets a string variable in the engine.
182 If the value contains unexpanded variables, set fFormatted to true.
130 183
131********************************************************************/ 184********************************************************************/
132DAPI_(HRESULT) BalSetStringVariable( 185DAPI_(HRESULT) BalSetStringVariable(
@@ -136,6 +189,36 @@ DAPI_(HRESULT) BalSetStringVariable(
136 ); 189 );
137 190
138/******************************************************************* 191/*******************************************************************
192BalGetVersionVariable - gets a version from a variable in the engine.
193
194 Note: Use StrFree() to release psczValue.
195********************************************************************/
196DAPI_(HRESULT) BalGetVersionVariable(
197 __in_z LPCWSTR wzVariable,
198 __inout LPWSTR* psczValue
199 );
200
201/*******************************************************************
202BalGetVersionVariableFromEngine - gets a version from a variable in the engine.
203
204 Note: Use StrFree() to release psczValue.
205********************************************************************/
206DAPI_(HRESULT) BalGetVersionVariableFromEngine(
207 __in IBootstrapperEngine* pEngine,
208 __in_z LPCWSTR wzVariable,
209 __inout LPWSTR* psczValue
210 );
211
212/*******************************************************************
213BalSetVersionVariable - sets a version variable in the engine.
214
215********************************************************************/
216DAPI_(HRESULT) BalSetVersionVariable(
217 __in_z LPCWSTR wzVariable,
218 __in_z_opt LPCWSTR wzValue
219 );
220
221/*******************************************************************
139 BalLog - logs a message with the engine. 222 BalLog - logs a message with the engine.
140 223
141********************************************************************/ 224********************************************************************/