ホーム › System.ApplicationInstallationAndServicing › MsiGetTargetPathA

MsiGetTargetPathA

関数

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

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

シグネチャ

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiGetTargetPathA(
    MSIHANDLE hInstall,
    LPCSTR szFolder,
    LPSTR szPathBuf,   // optional
    DWORD* pcchPathBuf   // optional
);

パラメーター

名前	型	方向	説明
hInstall	MSIHANDLE	in	DLL カスタムアクションに提供されるインストールのハンドル、または MsiOpenPackage、MsiOpenPackageEx、MsiOpenProduct を通じて取得したハンドル。
szFolder	LPCSTR	in	Directory テーブルのレコードを指定する null 終端文字列。ディレクトリがルートディレクトリの場合、これは DefaultDir 列の値にできます。それ以外の場合は、Directory 列の値である必要があります。
szPathBuf	LPSTR	outoptional	null 終端の完全なターゲットパスを受け取るバッファーへのポインター。szPathBuf に null (value=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 テーブル内のフォルダーに対する完全なターゲットパスを返します。(ANSI)

戻り値

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

解説(Remarks)

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

この関数を呼び出す前に、インストーラーはまず CostInitialize アクション、 FileCost アクション、 CostFinalize アクションを実行する必要があります。詳細については、Calling Database Functions from Programs を参照してください。

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

詳細については、 Calling Database Functions From Programs を参照してください。

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

メモ

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

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

各言語での呼び出し定義

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiGetTargetPathA(
    MSIHANDLE hInstall,
    LPCSTR szFolder,
    LPSTR szPathBuf,   // optional
    DWORD* pcchPathBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiGetTargetPathA(
    uint hInstall,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPStr)] string szFolder,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szPathBuf,   // LPSTR optional, out
    IntPtr pcchPathBuf   // DWORD* optional, in/out
);

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

' hInstall : MSIHANDLE
' szFolder : LPCSTR
' szPathBuf : LPSTR optional, out
' pcchPathBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiGetTargetPathA Lib "msi" ( _
    ByVal hInstall As Long, _
    ByVal szFolder As String, _
    ByVal szPathBuf As String, _
    ByVal pcchPathBuf As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetTargetPathA = Fiddle::Function.new(
  lib['MsiGetTargetPathA'],
  [
    -Fiddle::TYPE_INT,  # hInstall : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szFolder : LPCSTR
    Fiddle::TYPE_VOIDP,  # szPathBuf : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchPathBuf : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiGetTargetPathA(
        hInstall: u32,  // MSIHANDLE
        szFolder: *const u8,  // LPCSTR
        szPathBuf: *mut u8,  // LPSTR 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.Ansi)]
public static extern uint MsiGetTargetPathA(uint hInstall, [MarshalAs(UnmanagedType.LPStr)] string szFolder, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szPathBuf, IntPtr pcchPathBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetTargetPathA' -Namespace Win32 -PassThru
# $api::MsiGetTargetPathA(hInstall, szFolder, szPathBuf, pcchPathBuf)

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

出力引数:

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