summaryrefslogtreecommitdiff
path: root/setup_native/source/win32/customactions/reg4msdoc/msihelper.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'setup_native/source/win32/customactions/reg4msdoc/msihelper.hxx')
-rw-r--r--setup_native/source/win32/customactions/reg4msdoc/msihelper.hxx78
1 files changed, 39 insertions, 39 deletions
diff --git a/setup_native/source/win32/customactions/reg4msdoc/msihelper.hxx b/setup_native/source/win32/customactions/reg4msdoc/msihelper.hxx
index 483a66986859..2ff1a880f12e 100644
--- a/setup_native/source/win32/customactions/reg4msdoc/msihelper.hxx
+++ b/setup_native/source/win32/customactions/reg4msdoc/msihelper.hxx
@@ -15,43 +15,43 @@
#include <string>
/**
- Get the value of the named property
-
+ Get the value of the named property
+
@param handle
[in] a valid msi handle.
-
+
@param name
[in] the name of the property.
-
+
@param value
[out] receives thes value of the property.
-
- @returns
+
+ @returns
<TRUE/>if the property was found.
*/
bool GetMsiProp(MSIHANDLE handle, LPCTSTR name, /*out*/std::wstring& value);
/**
- Set the value of a binary property which can only
+ Set the value of a binary property which can only
have the values "0" or "1" to "1".
-
+
@param handle
[in] a valid msi handle.
-
+
@param name
- [in] the name of the property.
+ [in] the name of the property.
*/
void SetMsiProp(MSIHANDLE handle, LPCTSTR name);
/**
- Set the value of a binary property which can only
+ Set the value of a binary property which can only
have the values "0" or "1" to "0".
-
+
@param handle
[in] a valid msi handle.
-
+
@param name
- [in] the name of the property.
+ [in] the name of the property.
*/
void UnsetMsiProp(MSIHANDLE handle, LPCTSTR name);
@@ -59,7 +59,7 @@ void UnsetMsiProp(MSIHANDLE handle, LPCTSTR name);
Returns whether a certain property is set meaning
its value is "1". This method should be used for
binary properties whose value can be "0" or "1".
-
+
@returns
<TRUE/>if the value of the specified property is
"1" else if the property is not defined or its
@@ -71,7 +71,7 @@ bool IsSetMsiProp(MSIHANDLE handle, LPCTSTR name);
Returns whether a certain property is set meaning
its value is not empty. This method should be used for
properties, that can have different values.
-
+
@returns
<TRUE/>if the value of the specified property is
not empty. If it is empty <FALSE/> will be returned.
@@ -80,10 +80,10 @@ bool IsMsiPropNotEmpty(MSIHANDLE handle, LPCTSTR name);
/**
Query if this is an installation for all user or not.
-
+
@param handle
[in] a valid msi handle.
-
+
@returns
<TRUE/>if this is an all user installation
*/
@@ -92,10 +92,10 @@ bool IsAllUserInstallation(MSIHANDLE handle);
/**
Returns the destination folder of the office installation
as system path. The returned path contains a final '\'.
-
+
@param handle
[in] a valid msi handle.
-
+
@returns
the destination path of the office installation finalized
with a '\'.
@@ -105,10 +105,10 @@ std::wstring GetOfficeInstallationPath(MSIHANDLE handle);
/**
Returns the absolute path of the office executable that
will be installed as system path.
-
+
@param handle
[in] a valid msi handle.
-
+
@returns
the absolute system path of the office executable (e.g.
(C:\Program Files\StarOffice 8\program\soffice.exe").
@@ -118,25 +118,25 @@ std::wstring GetOfficeExecutablePath(MSIHANDLE handle);
/**
Get the name of the office that will be installed
(e.g. StarOffice 8, StarSuite 8, ...).
-
+
@param handle
[in] a valid msi handle.
-
- @returns
+
+ @returns
the name of the office product that will be installed.
*/
std::wstring GetProductName(MSIHANDLE handle);
/**
Determine if the specified module is installed locally.
-
+
@param handle
[in] a valid msi handle.
-
+
@param name
[in] the name of the module.
-
- @returns
+
+ @returns
<TRUE/>if the specified module is installed locally.
*/
bool IsModuleInstalled(MSIHANDLE handle, LPCTSTR name);
@@ -144,39 +144,39 @@ bool IsModuleInstalled(MSIHANDLE handle, LPCTSTR name);
/**
Determine if the specified module is selected to be installed
locally.
-
+
@param handle
[in] a valid msi handle.
-
+
@param name
[in] the name of the module.
-
+
@returns
- <TRUE/>if the specified module is about to be installed locally.
+ <TRUE/>if the specified module is about to be installed locally.
*/
bool IsModuleSelectedForInstallation(MSIHANDLE handle, LPCTSTR name);
/**
Determine if the specified module which is locally installed is
selected for deinstallation.
-
+
@param handle
[in] a valid msi handle.
-
+
@param name
[in] the name of the module.
-
- @returns
+
+ @returns
<TRUE/>if the specified module is about to be deinstalled.
*/
bool IsModuleSelectedForDeinstallation(MSIHANDLE handle, LPCTSTR name);
/**
Determine whether this is a complete uninstallation or not.
-
+
@param handle
[in] a valid msi handle.
-
+
@returns
<TRUE/>if this is a complete deinstallation.
*/