ホーム › System.ApplicationInstallationAndServicing › MsiGetTargetPathW

MsiGetTargetPathW

関数

フォルダーのターゲットパスを完全な形で取得する(Unicode版)。

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

シグネチャ

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

DWORD MsiGetTargetPathW(
    MSIHANDLE hInstall,
    LPCWSTR szFolder,
    LPWSTR szPathBuf,   // optional
    DWORD* pcchPathBuf   // optional
);

パラメーター

名前	型	方向	説明
hInstall	MSIHANDLE	in	DLL カスタムアクションに提供された、または MsiOpenPackage、MsiOpenPackageEx、MsiOpenProduct を通じて取得したインストールへのハンドル。
szFolder	LPCWSTR	in	Directory テーブルのレコードを指定する null 終端文字列。ディレクトリがルートディレクトリの場合、これは DefaultDir 列の値にできます。それ以外の場合は Directory 列の値でなければなりません。
szPathBuf	LPWSTR	outoptional	null 終端の完全なターゲットパスを受け取るバッファーへのポインター。szPathBuf に null (値=0) を渡してバッファーのサイズを判定しようとしないでください。バッファーのサイズは空文字列(例えば "")を渡すことで取得できます。その場合、関数は ERROR_MORE_DATA を返し、pcchPathBuf には終端の null 文字を含まない、必要なバッファーサイズが TCHAR 単位で格納されます。ERROR_SUCCESS が返された場合、pcchPathBuf には終端の null 文字を含まない、バッファーに書き込まれた TCHAR 数が格納されます。
pcchPathBuf	DWORD*	inoutoptional	変数 szPathBuf が指すバッファーのサイズを TCHAR 単位で指定する変数へのポインター。関数が ERROR_SUCCESS を返すとき、この変数には終端の null 文字を含まない、szPathBuf にコピーされたデータのサイズが格納されます。szPathBuf が十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、終端の null 文字を含まない必要なサイズを pcchPathBuf が指す変数に格納します。

戻り値の型: DWORD

公式ドキュメント

MsiGetTargetPath 関数は、Directory テーブル内のフォルダーの完全なターゲットパスを返します。(Unicode)

戻り値

MsiGetTargetPath 関数は次の値を返します:

解説(Remarks)

ERROR_MORE_DATA が返された場合、ポインターであるパラメーターは文字列を格納するために必要なバッファーのサイズを示します。ERROR_SUCCESS が返された場合は、文字列バッファーに書き込まれた文字数を示します。したがって、バッファーを指定するパラメーターに空文字列(例えば "")を渡すことで、バッファーのサイズを取得できます。null (値=0) を渡してバッファーのサイズを判定しようとしないでください。

この関数を呼び出す前に、インストーラーはまず CostInitialize アクション、 FileCost アクション、および CostFinalize アクションを実行する必要があります。詳細については、プログラムからのデータベース関数の呼び出しを参照してください。

ターゲットの現在の場所がインストールに利用できない場合、MsiGetTargetPath はパッケージで作成されたターゲットディレクトリの既定パスを返します。例えば、メンテナンスインストール中にネットワーク上のターゲットディレクトリが利用できない場合、インストーラーはターゲットディレクトリのパスを既定値にリセットします。この場合に実際のターゲットディレクトリのパスを取得するには、検索対象のディレクトリに以前インストールされたことが分かっているコンポーネントに対して MsiProvideComponent を呼び出し、dwInstallMode を INSTALLMODE_NODETECTION に設定します。

詳細については、プログラムからのデータベース関数の呼び出しを参照してください。

関数が失敗した場合、MsiGetLastErrorRecord を使用して拡張エラー情報を取得できます。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiGetTargetPathW(
    MSIHANDLE hInstall,
    LPCWSTR szFolder,
    LPWSTR szPathBuf,   // optional
    DWORD* pcchPathBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiGetTargetPathW(
    uint hInstall,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szFolder,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szPathBuf,   // LPWSTR optional, out
    IntPtr pcchPathBuf   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiGetTargetPathW(
    hInstall As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szFolder As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> szPathBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchPathBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' hInstall : MSIHANDLE
' szFolder : LPCWSTR
' szPathBuf : LPWSTR optional, out
' pcchPathBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiGetTargetPathW Lib "msi" ( _
    ByVal hInstall As Long, _
    ByVal szFolder As LongPtr, _
    ByVal szPathBuf As LongPtr, _
    ByVal pcchPathBuf As LongPtr) 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

MsiGetTargetPathW = ctypes.windll.msi.MsiGetTargetPathW
MsiGetTargetPathW.restype = wintypes.DWORD
MsiGetTargetPathW.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
    wintypes.LPCWSTR,  # szFolder : LPCWSTR
    wintypes.LPWSTR,  # szPathBuf : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchPathBuf : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetTargetPathW = Fiddle::Function.new(
  lib['MsiGetTargetPathW'],
  [
    -Fiddle::TYPE_INT,  # hInstall : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szFolder : LPCWSTR
    Fiddle::TYPE_VOIDP,  # szPathBuf : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchPathBuf : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiGetTargetPathW(
        hInstall: u32,  // MSIHANDLE
        szFolder: *const u16,  // LPCWSTR
        szPathBuf: *mut u16,  // LPWSTR optional, out
        pcchPathBuf: *mut u32  // DWORD* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiGetTargetPathW(uint hInstall, [MarshalAs(UnmanagedType.LPWStr)] string szFolder, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szPathBuf, IntPtr pcchPathBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetTargetPathW' -Namespace Win32 -PassThru
# $api::MsiGetTargetPathW(hInstall, szFolder, szPathBuf, pcchPathBuf)

#uselib "msi.dll"
#func global MsiGetTargetPathW "MsiGetTargetPathW" wptr, wptr, wptr, wptr
; MsiGetTargetPathW hInstall, szFolder, varptr(szPathBuf), varptr(pcchPathBuf)   ; 戻り値は stat
; hInstall : MSIHANDLE -> "wptr"
; szFolder : LPCWSTR -> "wptr"
; szPathBuf : LPWSTR optional, out -> "wptr"
; pcchPathBuf : DWORD* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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