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

関数がディスク領域の要件を決定するために使用する値を指定します。 このパラメーターには、次の値のいずれかを指定できます。

[in] iState

インストールの状態を指定します。 このパラメーターには、次の値のいずれかを指定できます。

[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 を使用して拡張エラー情報を取得できます。

要件

関連項目

インストーラーの選択関数

Windows インストーラー関数の引数として Null を渡す