MsiGetFeatureCostA 函数 (msiquery.h)

  • 项目

MsiGetFeatureCost 函数返回功能及其所选子项和父功能所需的磁盘空间。

语法

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

parameters

[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 标头将 MsiGetFeatureCost 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 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
Library Msi.lib
DLL Msi.dll

请参阅

安装程序选择函数

将 Null 作为 Windows Installer 函数的参数传递