ホーム › System.ApplicationInstallationAndServicing › MsiEnumComponentCostsW

MsiEnumComponentCostsW

関数

コンポーネントのドライブ別ディスクコストを列挙する(Unicode版)。

DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiEnumComponentCostsW(
    MSIHANDLE hInstall,
    LPCWSTR szComponent,
    DWORD dwIndex,
    INSTALLSTATE iState,
    LPWSTR szDriveBuf,
    DWORD* pcchDriveBuf,
    INT* piCost,
    INT* piTempCost
);

パラメーター

名前	型	方向	説明
hInstall	MSIHANDLE	in	DLL カスタムアクションに提供された、または MsiOpenPackage、MsiOpenPackageEx、MsiOpenProduct から取得したインストールへのハンドル。
szComponent	LPCWSTR	in	Component テーブルの Component 列に列挙されているとおりのコンポーネント名を指定する、null で終わる文字列。このパラメーターは null を指定できます。szComponent が null または空文字列の場合、 MsiEnumComponentCosts はインストール中に使用されるドライブごとの合計ディスク領域を列挙します。この場合、iState は無視されます。インストーラーのコストには、セキュアフォルダーへのデータベースのキャッシュに要するコストや、インストールスクリプトの作成に要するコストが含まれます。インストール中に使用される合計ディスク領域は、コンポーネントのインストール後に使用される領域より大きくなる場合がある点に注意してください。
dwIndex	DWORD	in	ドライブの 0 から始まるインデックス。このパラメーターは、 MsiEnumComponentCosts 関数の最初の呼び出しでは 0 とし、以降の呼び出しでは増分する必要があります。
iState	INSTALLSTATE	in	列挙対象として要求されるコンポーネントの状態。szComponent に Null または空文字列を渡した場合、インストーラーは iState パラメーターを無視します。
szDriveBuf	LPWSTR	out	null 終端文字を含むドライブ名を保持するバッファー。エラーが発生した場合は空文字列になります。
pcchDriveBuf	DWORD*	inout	lpDriveBuf パラメーターが指すバッファーのサイズを TCHAR 単位で指定する変数へのポインター。このサイズには終端の null 文字を含める必要があります。指定されたバッファーが小さすぎる場合、pcchDriveBuf が指す変数には null 終端文字を含まない文字数が格納されます。
piCost	INT*	out	ドライブごとのコンポーネントのコスト。512 バイトの倍数で表されます。エラーが発生した場合、この値は 0 になります。piCost で返される値は、インストール後にコンポーネントが使用する最終的なディスク領域です。szComponent に Null または空文字列を渡した場合、インストーラーは piCost の値を 0 に設定します。
piTempCost	INT*	out	インストール期間中のドライブごとのコンポーネントコスト。エラーが発生した場合は 0 です。*piTempCost の値は、インストール期間中に必要となる一時的な領域要件を表します。この一時的な領域要件は、インストール期間中のみ必要となる領域です。これは最終的なディスク領域要件には影響しません。

戻り値の型: DWORD

公式ドキュメント

MsiEnumComponentCosts 関数は、コンポーネントのインストールに必要なディスク領域をドライブごとに列挙します。(Unicode)

戻り値

戻り値	意味
ERROR_INVALID_HANDLE_STATE	構成データが破損しています。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。
ERROR_NO_MORE_ITEMS	返すドライブがこれ以上ありません。
ERROR_SUCCESS	値が列挙されました。
ERROR_UNKNOWN_COMPONENT	コンポーネントが見つかりません。
ERROR_FUNCTION_NOT_CALLED	コスト計算が完了していません。
ERROR_MORE_DATA	ドライブ名に対してバッファーが十分な大きさではありません。
ERROR_INVALID_HANDLE	指定されたハンドルが無効または非アクティブです。

解説(Remarks)

ドライブごとのディスク領域コストを列挙する推奨方法は次のとおりです。dwIndex を 0 に設定して開始し、呼び出しごとに 1 ずつ増分します。 MsiEnumComponentCosts が ERROR_SUCCESS を返す限り、列挙を続行します。

MsiEnumComponentCosts はカスタムアクションから呼び出すことができます。

インストールの最終的な合計ディスクコストは、すべてのコンポーネントのコストの合計に、Windows インストーラーのコスト(szComponent = null)を加えたものです。

メモ

msiquery.h ヘッダーは、MsiEnumComponentCosts を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiEnumComponentCostsW(
    MSIHANDLE hInstall,
    LPCWSTR szComponent,
    DWORD dwIndex,
    INSTALLSTATE iState,
    LPWSTR szDriveBuf,
    DWORD* pcchDriveBuf,
    INT* piCost,
    INT* piTempCost
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiEnumComponentCostsW(
    uint hInstall,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szComponent,   // LPCWSTR
    uint dwIndex,   // DWORD
    int iState,   // INSTALLSTATE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szDriveBuf,   // LPWSTR out
    ref uint pcchDriveBuf,   // DWORD* in/out
    out int piCost,   // INT* out
    out int piTempCost   // INT* out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiEnumComponentCostsW(
    hInstall As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szComponent As String,   ' LPCWSTR
    dwIndex As UInteger,   ' DWORD
    iState As Integer,   ' INSTALLSTATE
    <MarshalAs(UnmanagedType.LPWStr)> szDriveBuf As System.Text.StringBuilder,   ' LPWSTR out
    ByRef pcchDriveBuf As UInteger,   ' DWORD* in/out
    <Out> ByRef piCost As Integer,   ' INT* out
    <Out> ByRef piTempCost As Integer   ' INT* out
) As UInteger
End Function

' hInstall : MSIHANDLE
' szComponent : LPCWSTR
' dwIndex : DWORD
' iState : INSTALLSTATE
' szDriveBuf : LPWSTR out
' pcchDriveBuf : DWORD* in/out
' piCost : INT* out
' piTempCost : INT* out
Declare PtrSafe Function MsiEnumComponentCostsW Lib "msi" ( _
    ByVal hInstall As Long, _
    ByVal szComponent As LongPtr, _
    ByVal dwIndex As Long, _
    ByVal iState As Long, _
    ByVal szDriveBuf As LongPtr, _
    ByRef pcchDriveBuf As Long, _
    ByRef piCost As Long, _
    ByRef piTempCost As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiEnumComponentCostsW = ctypes.windll.msi.MsiEnumComponentCostsW
MsiEnumComponentCostsW.restype = wintypes.DWORD
MsiEnumComponentCostsW.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
    wintypes.LPCWSTR,  # szComponent : LPCWSTR
    wintypes.DWORD,  # dwIndex : DWORD
    ctypes.c_int,  # iState : INSTALLSTATE
    wintypes.LPWSTR,  # szDriveBuf : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchDriveBuf : DWORD* in/out
    ctypes.POINTER(ctypes.c_int),  # piCost : INT* out
    ctypes.POINTER(ctypes.c_int),  # piTempCost : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumComponentCostsW = Fiddle::Function.new(
  lib['MsiEnumComponentCostsW'],
  [
    -Fiddle::TYPE_INT,  # hInstall : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szComponent : LPCWSTR
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_INT,  # iState : INSTALLSTATE
    Fiddle::TYPE_VOIDP,  # szDriveBuf : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pcchDriveBuf : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # piCost : INT* out
    Fiddle::TYPE_VOIDP,  # piTempCost : INT* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiEnumComponentCostsW(
        hInstall: u32,  // MSIHANDLE
        szComponent: *const u16,  // LPCWSTR
        dwIndex: u32,  // DWORD
        iState: i32,  // INSTALLSTATE
        szDriveBuf: *mut u16,  // LPWSTR out
        pcchDriveBuf: *mut u32,  // DWORD* in/out
        piCost: *mut i32,  // INT* out
        piTempCost: *mut i32  // INT* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiEnumComponentCostsW(uint hInstall, [MarshalAs(UnmanagedType.LPWStr)] string szComponent, uint dwIndex, int iState, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szDriveBuf, ref uint pcchDriveBuf, out int piCost, out int piTempCost);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumComponentCostsW' -Namespace Win32 -PassThru
# $api::MsiEnumComponentCostsW(hInstall, szComponent, dwIndex, iState, szDriveBuf, pcchDriveBuf, piCost, piTempCost)

#uselib "msi.dll"
#func global MsiEnumComponentCostsW "MsiEnumComponentCostsW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; MsiEnumComponentCostsW hInstall, szComponent, dwIndex, iState, varptr(szDriveBuf), varptr(pcchDriveBuf), varptr(piCost), varptr(piTempCost)   ; 戻り値は stat
; hInstall : MSIHANDLE -> "wptr"
; szComponent : LPCWSTR -> "wptr"
; dwIndex : DWORD -> "wptr"
; iState : INSTALLSTATE -> "wptr"
; szDriveBuf : LPWSTR out -> "wptr"
; pcchDriveBuf : DWORD* in/out -> "wptr"
; piCost : INT* out -> "wptr"
; piTempCost : INT* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiEnumComponentCostsW "MsiEnumComponentCostsW" int, wstr, int, int, var, var, var, var
; res = MsiEnumComponentCostsW(hInstall, szComponent, dwIndex, iState, szDriveBuf, pcchDriveBuf, piCost, piTempCost)
; hInstall : MSIHANDLE -> "int"
; szComponent : LPCWSTR -> "wstr"
; dwIndex : DWORD -> "int"
; iState : INSTALLSTATE -> "int"
; szDriveBuf : LPWSTR out -> "var"
; pcchDriveBuf : DWORD* in/out -> "var"
; piCost : INT* out -> "var"
; piTempCost : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiEnumComponentCostsW "MsiEnumComponentCostsW" int, wstr, int, int, sptr, sptr, sptr, sptr
; res = MsiEnumComponentCostsW(hInstall, szComponent, dwIndex, iState, varptr(szDriveBuf), varptr(pcchDriveBuf), varptr(piCost), varptr(piTempCost))
; hInstall : MSIHANDLE -> "int"
; szComponent : LPCWSTR -> "wstr"
; dwIndex : DWORD -> "int"
; iState : INSTALLSTATE -> "int"
; szDriveBuf : LPWSTR out -> "sptr"
; pcchDriveBuf : DWORD* in/out -> "sptr"
; piCost : INT* out -> "sptr"
; piTempCost : INT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。