MsiGetFeatureCostW 関数 (msiquery.h)

  • [アーティクル]

MsiGetFeatureCost 関数は、機能と、選択した子と親の機能に必要なディスク領域を返します。

構文

UINT MsiGetFeatureCostW(
  [in]  MSIHANDLE    hInstall,
  [in]  LPCWSTR      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 ヘッダーは、MSIGetFeatureCost をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows Server 2012、Windows 8、Windows Server 2008 R2、または Windows 7 の Windows インストーラー 5.0。 Windows Server 2008 または Windows Vista の Windows インストーラー 4.0 または Windows インストーラー 4.5。 Windows Server 2003 または Windows XP の Windows インストーラー
対象プラットフォーム Windows
ヘッダー msiquery.h
Library Msi.lib
[DLL] Msi.dll

こちらもご覧ください

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

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