Share via

msiGetFeatureCostA 函式 (msiquery.h)

  • 發行項

MsiGetFeatureCost函式會傳回功能所需的磁碟空間及其選取的子系和父功能。

語法

UINT MsiGetFeatureCostA(
  [in]  MSIHANDLE    hInstall,
  [in]  LPCSTR       szFeature,
  [in]  MSICOSTTREE  iCostTree,
  [in]  INSTALLSTATE iState,
  [out] LPINT        piCost
);

參數

[in] hInstall

處理提供給 DLL 自訂動作的安裝，或透過 MsiOpenPackage、 MsiOpenPackageEx或 MsiOpenProduct取得。

[in] szFeature

指定功能的名稱。

[in] iCostTree

指定函式用來判斷磁碟空間需求的值。 此參數可以是下列其中一個值。

值 意義
MSICOSTTREE_CHILDREN
 所指示功能的子系包含在成本中。
MSICOSTTREE_PARENTS
 所指示功能的父功能包含在成本中。
MSICOSTTREE_SELFONLY
 此功能只會包含在成本中。

[in] iState

指定安裝狀態。 此參數可以是下列其中一個值。

值 意義
INSTALLSTATE_UNKNOWN
 無法辨識產品或功能。
INSTALLSTATE_ABSENT
 產品或功能已卸載。
INSTALLSTATE_LOCAL
 產品或功能會安裝在本機磁片磁碟機上。
INSTALLSTATE_SOURCE
 產品或功能會安裝以從來源、CD 或網路執行。
INSTALLSTATE_DEFAULT
 產品或功能將會安裝為使用預設位置：本機或來源。

[out] piCost

以 512 個位元組為單位接收磁碟空間需求。 此參數不得為 null。

傳回值

MsiGetFeatureCost函式會傳回下列值：

備註

請參閱 從程式呼叫資料庫函式。

使用 MsiGetFeatureCost 函式時，MSICOSTTREE_SELFONLY值會指出指定功能所需 512 個位元組的單位 (磁碟空間總計) 。 這個傳回的值不包含指定功能的子系或父特徵。 此總成本是由連結至功能之每個元件所屬性的磁片成本所組成。

MSICOSTTREE_CHILDREN值表示指定功能及其子系所需的 512 位元組 (磁碟空間總數) 。 針對每個功能，總成本是由每個連結至功能之元件的磁片成本所組成。

MSICOSTTREE_PARENTS值表示指定功能所需的磁碟空間總 (單位為 512 個位元組) ，且其父功能最多 (功能 資料表 的根目錄) 。 針對每個功能，總成本是由每個連結至功能之元件的磁片成本所組成。

MsiGetFeatureCost 相依于數個其他函式，才能成功。 下列範例示範必須呼叫這些函式的順序：

MSIHANDLE   hInstall;      //product handle, must be closed
int         iCost;         //cost returned by MsiGetFeatureCost

MsiOpenPackage("Path to package....",&hInstall);   //"Path to package...." should be replaced with the full path to the package to be opened
MsiDoAction(hInstall,"CostInitialize");         //
MsiDoAction(hInstall,"FileCost");
MsiDoAction(hInstall,"CostFinalize");
MsiDoAction(hInstall,"InstallValidate");
MsiGetFeatureCost(hInstall,"FeatureName",MSICOSTTREE_SELFONLY,INSTALLSTATE_ABSENT,&iCost);
MsiCloseHandle(hInstall);                        //close the open product handle

查詢排定移除之功能成本的程式稍有不同：

MSIHANDLE   hInstall;      //product handle, must be closed
int         iCost;         //cost returned by MsiGetFeatureCost

MsiOpenPackage("Path to package....",&hInstall);              //"Path to package...." should be replaced with the full path to the package to be opened
MsiDoAction(hInstall,"CostInitialize");                          //
MsiDoAction(hInstall,"FileCost");
MsiDoAction(hInstall,"CostFinalize");
MsiSetFeatureState(hInstall,"FeatureName",INSTALLSTATE_ABSENT);  //set the feature's state to "not installed"
MsiDoAction(hInstall,"InstallValidate");
MsiGetFeatureCost(hInstall,"FeatureName",MSICOSTTREE_SELFONLY,INSTALLSTATE_ABSENT,&iCost);
MsiCloseHandle(hInstall);                                        //close the open product handle

如果函式失敗，您可以使用 MsiGetLastErrorRecord取得擴充錯誤資訊。

注意

msiquery.h 標頭會根據 UNICODE 預處理器常數的定義，將 MsiGetFeatureCost 定義為別名，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼，可能會導致編譯或執行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

需求

   
最低支援的用戶端 Windows Server 2012、Windows 8、Windows Server 2008 R2 或 Windows 7 上的 Windows Installer 5.0。 Windows Server 2008 或 Windows Vista 上的 Windows Installer 4.0 或 Windows Installer 4.5。 Windows Server 2003 或 Windows XP 上的 Windows Installer
目標平台 Windows
標頭 msiquery.h
程式庫 Msi.lib
Dll Msi.dll

另請參閱

安裝程式選取函式

傳遞 Null 作為 Windows Installer 函式的引數