1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski #ifndef INCLUDED_MSIHELPER_HXX 23*b1cdbd2cSJim Jagielski #define INCLUDED_MSIHELPER_HXX 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski #ifdef _MSC_VER 26*b1cdbd2cSJim Jagielski #pragma warning(push, 1) /* disable warnings within system headers */ 27*b1cdbd2cSJim Jagielski #endif 28*b1cdbd2cSJim Jagielski #define WIN32_LEAN_AND_MEAN 29*b1cdbd2cSJim Jagielski #include <windows.h> 30*b1cdbd2cSJim Jagielski #include <msiquery.h> 31*b1cdbd2cSJim Jagielski #ifdef _MSC_VER 32*b1cdbd2cSJim Jagielski #pragma warning(pop) 33*b1cdbd2cSJim Jagielski #endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski #include <string> 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski /** 38*b1cdbd2cSJim Jagielski Get the value of the named property 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski @param handle 41*b1cdbd2cSJim Jagielski [in] a valid msi handle. 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski @param name 44*b1cdbd2cSJim Jagielski [in] the name of the property. 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski @param value 47*b1cdbd2cSJim Jagielski [out] receives thes value of the property. 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski @returns 50*b1cdbd2cSJim Jagielski <TRUE/>if the property was found. 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielski bool GetMsiProp(MSIHANDLE handle, LPCTSTR name, /*out*/std::wstring& value); 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski /** 55*b1cdbd2cSJim Jagielski Set the value of a binary property which can only 56*b1cdbd2cSJim Jagielski have the values "0" or "1" to "1". 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski @param handle 59*b1cdbd2cSJim Jagielski [in] a valid msi handle. 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski @param name 62*b1cdbd2cSJim Jagielski [in] the name of the property. 63*b1cdbd2cSJim Jagielski */ 64*b1cdbd2cSJim Jagielski void SetMsiProp(MSIHANDLE handle, LPCTSTR name); 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski /** 67*b1cdbd2cSJim Jagielski Set the value of a binary property which can only 68*b1cdbd2cSJim Jagielski have the values "0" or "1" to "0". 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski @param handle 71*b1cdbd2cSJim Jagielski [in] a valid msi handle. 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski @param name 74*b1cdbd2cSJim Jagielski [in] the name of the property. 75*b1cdbd2cSJim Jagielski */ 76*b1cdbd2cSJim Jagielski void UnsetMsiProp(MSIHANDLE handle, LPCTSTR name); 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski /** 79*b1cdbd2cSJim Jagielski Returns whether a certain property is set meaning 80*b1cdbd2cSJim Jagielski its value is "1". This method should be used for 81*b1cdbd2cSJim Jagielski binary properties whose value can be "0" or "1". 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @returns 84*b1cdbd2cSJim Jagielski <TRUE/>if the value of the specified property is 85*b1cdbd2cSJim Jagielski "1" else if the property is not defined or its 86*b1cdbd2cSJim Jagielski value is other than "1" <FALSE/> will be returned. 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski bool IsSetMsiProp(MSIHANDLE handle, LPCTSTR name); 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski /** 91*b1cdbd2cSJim Jagielski Returns whether a certain property is set meaning 92*b1cdbd2cSJim Jagielski its value is not empty. This method should be used for 93*b1cdbd2cSJim Jagielski properties, that can have different values. 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski @returns 96*b1cdbd2cSJim Jagielski <TRUE/>if the value of the specified property is 97*b1cdbd2cSJim Jagielski not empty. If it is empty <FALSE/> will be returned. 98*b1cdbd2cSJim Jagielski */ 99*b1cdbd2cSJim Jagielski bool IsMsiPropNotEmpty(MSIHANDLE handle, LPCTSTR name); 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski /** 102*b1cdbd2cSJim Jagielski Query if this is an installation for all user or not. 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski @param handle 105*b1cdbd2cSJim Jagielski [in] a valid msi handle. 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski @returns 108*b1cdbd2cSJim Jagielski <TRUE/>if this is an all user installation 109*b1cdbd2cSJim Jagielski */ 110*b1cdbd2cSJim Jagielski bool IsAllUserInstallation(MSIHANDLE handle); 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski /** 113*b1cdbd2cSJim Jagielski Returns the destination folder of the office installation 114*b1cdbd2cSJim Jagielski as system path. The returned path contains a final '\'. 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski @param handle 117*b1cdbd2cSJim Jagielski [in] a valid msi handle. 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski @returns 120*b1cdbd2cSJim Jagielski the destination path of the office installation finalized 121*b1cdbd2cSJim Jagielski with a '\'. 122*b1cdbd2cSJim Jagielski */ 123*b1cdbd2cSJim Jagielski std::wstring GetOfficeInstallationPath(MSIHANDLE handle); 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski /** 126*b1cdbd2cSJim Jagielski Returns the absolute path of the office executable that 127*b1cdbd2cSJim Jagielski will be installed as system path. 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski @param handle 130*b1cdbd2cSJim Jagielski [in] a valid msi handle. 131*b1cdbd2cSJim Jagielski 132*b1cdbd2cSJim Jagielski @returns 133*b1cdbd2cSJim Jagielski the absolute system path of the office executable (e.g. 134*b1cdbd2cSJim Jagielski (C:\Program Files\StarOffice 8\program\soffice.exe"). 135*b1cdbd2cSJim Jagielski */ 136*b1cdbd2cSJim Jagielski std::wstring GetOfficeExecutablePath(MSIHANDLE handle); 137*b1cdbd2cSJim Jagielski 138*b1cdbd2cSJim Jagielski /** 139*b1cdbd2cSJim Jagielski Get the name of the office that will be installed 140*b1cdbd2cSJim Jagielski (e.g. StarOffice 8, StarSuite 8, ...). 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski @param handle 143*b1cdbd2cSJim Jagielski [in] a valid msi handle. 144*b1cdbd2cSJim Jagielski 145*b1cdbd2cSJim Jagielski @returns 146*b1cdbd2cSJim Jagielski the name of the office product that will be installed. 147*b1cdbd2cSJim Jagielski */ 148*b1cdbd2cSJim Jagielski std::wstring GetProductName(MSIHANDLE handle); 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski /** 151*b1cdbd2cSJim Jagielski Determine if the specified module is installed locally. 152*b1cdbd2cSJim Jagielski 153*b1cdbd2cSJim Jagielski @param handle 154*b1cdbd2cSJim Jagielski [in] a valid msi handle. 155*b1cdbd2cSJim Jagielski 156*b1cdbd2cSJim Jagielski @param name 157*b1cdbd2cSJim Jagielski [in] the name of the module. 158*b1cdbd2cSJim Jagielski 159*b1cdbd2cSJim Jagielski @returns 160*b1cdbd2cSJim Jagielski <TRUE/>if the specified module is installed locally. 161*b1cdbd2cSJim Jagielski */ 162*b1cdbd2cSJim Jagielski bool IsModuleInstalled(MSIHANDLE handle, LPCTSTR name); 163*b1cdbd2cSJim Jagielski 164*b1cdbd2cSJim Jagielski /** 165*b1cdbd2cSJim Jagielski Determine if the specified module is selected to be installed 166*b1cdbd2cSJim Jagielski locally. 167*b1cdbd2cSJim Jagielski 168*b1cdbd2cSJim Jagielski @param handle 169*b1cdbd2cSJim Jagielski [in] a valid msi handle. 170*b1cdbd2cSJim Jagielski 171*b1cdbd2cSJim Jagielski @param name 172*b1cdbd2cSJim Jagielski [in] the name of the module. 173*b1cdbd2cSJim Jagielski 174*b1cdbd2cSJim Jagielski @returns 175*b1cdbd2cSJim Jagielski <TRUE/>if the specified module is about to be installed locally. 176*b1cdbd2cSJim Jagielski */ 177*b1cdbd2cSJim Jagielski bool IsModuleSelectedForInstallation(MSIHANDLE handle, LPCTSTR name); 178*b1cdbd2cSJim Jagielski 179*b1cdbd2cSJim Jagielski /** 180*b1cdbd2cSJim Jagielski Determine if the specified module which is locally installed is 181*b1cdbd2cSJim Jagielski selected for deinstallation. 182*b1cdbd2cSJim Jagielski 183*b1cdbd2cSJim Jagielski @param handle 184*b1cdbd2cSJim Jagielski [in] a valid msi handle. 185*b1cdbd2cSJim Jagielski 186*b1cdbd2cSJim Jagielski @param name 187*b1cdbd2cSJim Jagielski [in] the name of the module. 188*b1cdbd2cSJim Jagielski 189*b1cdbd2cSJim Jagielski @returns 190*b1cdbd2cSJim Jagielski <TRUE/>if the specified module is about to be deinstalled. 191*b1cdbd2cSJim Jagielski */ 192*b1cdbd2cSJim Jagielski bool IsModuleSelectedForDeinstallation(MSIHANDLE handle, LPCTSTR name); 193*b1cdbd2cSJim Jagielski 194*b1cdbd2cSJim Jagielski /** 195*b1cdbd2cSJim Jagielski Determine whether this is a complete uninstallation or not. 196*b1cdbd2cSJim Jagielski 197*b1cdbd2cSJim Jagielski @param handle 198*b1cdbd2cSJim Jagielski [in] a valid msi handle. 199*b1cdbd2cSJim Jagielski 200*b1cdbd2cSJim Jagielski @returns 201*b1cdbd2cSJim Jagielski <TRUE/>if this is a complete deinstallation. 202*b1cdbd2cSJim Jagielski */ 203*b1cdbd2cSJim Jagielski bool IsCompleteDeinstallation(MSIHANDLE handle); 204*b1cdbd2cSJim Jagielski 205*b1cdbd2cSJim Jagielski #endif 206