MsiSetTargetPathW
関数シグネチャ
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiSetTargetPathW(
MSIHANDLE hInstall,
LPCWSTR szFolder,
LPCWSTR szFolderPath
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hInstall | MSIHANDLE | in | DLL カスタムアクションに提供されたインストールのハンドル、または MsiOpenPackage、MsiOpenPackageEx、MsiOpenProduct を通じて取得したハンドルを指定します。 |
| szFolder | LPCWSTR | in | フォルダー識別子を指定します。これは Directory テーブルの主キーです。 |
| szFolderPath | LPCWSTR | in | フォルダーの完全なパスを指定します。末尾はディレクトリ区切り文字で終わる必要があります。 |
戻り値の型: DWORD
公式ドキュメント
MsiSetTargetPath 関数は、Directory テーブル内のフォルダーに対する完全なターゲットパスを設定します。(Unicode)
戻り値
MsiSetTargetPath 関数は次の値を返します。
解説(Remarks)
MsiSetTargetPath 関数は、メモリ内の Directory テーブル で指定されたターゲットディレクトリのパス指定を変更します。また、テーブル内で変更対象のパスに従属、または等価なその他すべてのパスオブジェクトのパス指定も、この変更を反映するように更新されます。影響を受ける各パスのプロパティも併せて更新されます。
選択したディレクトリが読み取り専用の場合、 MsiSetTargetPath は失敗します。
この関数でエラーが発生した場合、更新されたすべてのパスとプロパティは以前の値に戻されます。したがって、この関数が返すエラーは致命的ではないものとして扱っても安全です。
これらのパスを使用するコンポーネントが、現在のユーザーまたは別のユーザーに対して既にインストールされている場合は、ターゲットパスの構成を試みないでください。 MsiSetTargetPath を呼び出す前に ProductState プロパティを確認し、このコンポーネントを含む製品がインストールされているかどうかを判断してください。
プログラムからのデータベース関数の呼び出し を参照してください。
関数が失敗した場合、MsiGetLastErrorRecord を使用して拡張エラー情報を取得できます。
msiquery.h ヘッダーは、MsiSetTargetPath を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約 を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiSetTargetPathW(
MSIHANDLE hInstall,
LPCWSTR szFolder,
LPCWSTR szFolderPath
);[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiSetTargetPathW(
uint hInstall, // MSIHANDLE
[MarshalAs(UnmanagedType.LPWStr)] string szFolder, // LPCWSTR
[MarshalAs(UnmanagedType.LPWStr)] string szFolderPath // LPCWSTR
);<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiSetTargetPathW(
hInstall As UInteger, ' MSIHANDLE
<MarshalAs(UnmanagedType.LPWStr)> szFolder As String, ' LPCWSTR
<MarshalAs(UnmanagedType.LPWStr)> szFolderPath As String ' LPCWSTR
) As UInteger
End Function' hInstall : MSIHANDLE
' szFolder : LPCWSTR
' szFolderPath : LPCWSTR
Declare PtrSafe Function MsiSetTargetPathW Lib "msi" ( _
ByVal hInstall As Long, _
ByVal szFolder As LongPtr, _
ByVal szFolderPath 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
MsiSetTargetPathW = ctypes.windll.msi.MsiSetTargetPathW
MsiSetTargetPathW.restype = wintypes.DWORD
MsiSetTargetPathW.argtypes = [
wintypes.DWORD, # hInstall : MSIHANDLE
wintypes.LPCWSTR, # szFolder : LPCWSTR
wintypes.LPCWSTR, # szFolderPath : LPCWSTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiSetTargetPathW = Fiddle::Function.new(
lib['MsiSetTargetPathW'],
[
-Fiddle::TYPE_INT, # hInstall : MSIHANDLE
Fiddle::TYPE_VOIDP, # szFolder : LPCWSTR
Fiddle::TYPE_VOIDP, # szFolderPath : LPCWSTR
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "msi")]
extern "system" {
fn MsiSetTargetPathW(
hInstall: u32, // MSIHANDLE
szFolder: *const u16, // LPCWSTR
szFolderPath: *const u16 // LPCWSTR
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiSetTargetPathW(uint hInstall, [MarshalAs(UnmanagedType.LPWStr)] string szFolder, [MarshalAs(UnmanagedType.LPWStr)] string szFolderPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiSetTargetPathW' -Namespace Win32 -PassThru
# $api::MsiSetTargetPathW(hInstall, szFolder, szFolderPath)#uselib "msi.dll"
#func global MsiSetTargetPathW "MsiSetTargetPathW" wptr, wptr, wptr
; MsiSetTargetPathW hInstall, szFolder, szFolderPath ; 戻り値は stat
; hInstall : MSIHANDLE -> "wptr"
; szFolder : LPCWSTR -> "wptr"
; szFolderPath : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "msi.dll"
#cfunc global MsiSetTargetPathW "MsiSetTargetPathW" int, wstr, wstr
; res = MsiSetTargetPathW(hInstall, szFolder, szFolderPath)
; hInstall : MSIHANDLE -> "int"
; szFolder : LPCWSTR -> "wstr"
; szFolderPath : LPCWSTR -> "wstr"; DWORD MsiSetTargetPathW(MSIHANDLE hInstall, LPCWSTR szFolder, LPCWSTR szFolderPath)
#uselib "msi.dll"
#cfunc global MsiSetTargetPathW "MsiSetTargetPathW" int, wstr, wstr
; res = MsiSetTargetPathW(hInstall, szFolder, szFolderPath)
; hInstall : MSIHANDLE -> "int"
; szFolder : LPCWSTR -> "wstr"
; szFolderPath : LPCWSTR -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiSetTargetPathW = msi.NewProc("MsiSetTargetPathW")
)
// hInstall (MSIHANDLE), szFolder (LPCWSTR), szFolderPath (LPCWSTR)
r1, _, err := procMsiSetTargetPathW.Call(
uintptr(hInstall),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szFolder))),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szFolderPath))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiSetTargetPathW(
hInstall: DWORD; // MSIHANDLE
szFolder: PWideChar; // LPCWSTR
szFolderPath: PWideChar // LPCWSTR
): DWORD; stdcall;
external 'msi.dll' name 'MsiSetTargetPathW';result := DllCall("msi\MsiSetTargetPathW"
, "UInt", hInstall ; MSIHANDLE
, "WStr", szFolder ; LPCWSTR
, "WStr", szFolderPath ; LPCWSTR
, "UInt") ; return: DWORD●MsiSetTargetPathW(hInstall, szFolder, szFolderPath) = DLL("msi.dll", "dword MsiSetTargetPathW(dword, char*, char*)")
# 呼び出し: MsiSetTargetPathW(hInstall, szFolder, szFolderPath)
# hInstall : MSIHANDLE -> "dword"
# szFolder : LPCWSTR -> "char*"
# szFolderPath : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "msi" fn MsiSetTargetPathW(
hInstall: u32, // MSIHANDLE
szFolder: [*c]const u16, // LPCWSTR
szFolderPath: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc MsiSetTargetPathW(
hInstall: uint32, # MSIHANDLE
szFolder: WideCString, # LPCWSTR
szFolderPath: WideCString # LPCWSTR
): uint32 {.importc: "MsiSetTargetPathW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "msi");
extern(Windows)
uint MsiSetTargetPathW(
uint hInstall, // MSIHANDLE
const(wchar)* szFolder, // LPCWSTR
const(wchar)* szFolderPath // LPCWSTR
);ccall((:MsiSetTargetPathW, "msi.dll"), stdcall, UInt32,
(UInt32, Cwstring, Cwstring),
hInstall, szFolder, szFolderPath)
# hInstall : MSIHANDLE -> UInt32
# szFolder : LPCWSTR -> Cwstring
# szFolderPath : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiSetTargetPathW(
uint32_t hInstall,
const uint16_t* szFolder,
const uint16_t* szFolderPath);
]]
local msi = ffi.load("msi")
-- msi.MsiSetTargetPathW(hInstall, szFolder, szFolderPath)
-- hInstall : MSIHANDLE
-- szFolder : LPCWSTR
-- szFolderPath : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiSetTargetPathW = lib.func('__stdcall', 'MsiSetTargetPathW', 'uint32_t', ['uint32_t', 'str16', 'str16']);
// MsiSetTargetPathW(hInstall, szFolder, szFolderPath)
// hInstall : MSIHANDLE -> 'uint32_t'
// szFolder : LPCWSTR -> 'str16'
// szFolderPath : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiSetTargetPathW: { parameters: ["u32", "buffer", "buffer"], result: "u32" },
});
// lib.symbols.MsiSetTargetPathW(hInstall, szFolder, szFolderPath)
// hInstall : MSIHANDLE -> "u32"
// szFolder : LPCWSTR -> "buffer"
// szFolderPath : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiSetTargetPathW(
uint32_t hInstall,
const uint16_t* szFolder,
const uint16_t* szFolderPath);
C, "msi.dll");
// $ffi->MsiSetTargetPathW(hInstall, szFolder, szFolderPath);
// hInstall : MSIHANDLE
// szFolder : LPCWSTR
// szFolderPath : LPCWSTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Msi extends StdCallLibrary {
Msi INSTANCE = Native.load("msi", Msi.class, W32APIOptions.UNICODE_OPTIONS);
int MsiSetTargetPathW(
int hInstall, // MSIHANDLE
WString szFolder, // LPCWSTR
WString szFolderPath // LPCWSTR
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("msi")]
lib Libmsi
fun MsiSetTargetPathW = MsiSetTargetPathW(
hInstall : UInt32, # MSIHANDLE
szFolder : UInt16*, # LPCWSTR
szFolderPath : UInt16* # LPCWSTR
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MsiSetTargetPathWNative = Uint32 Function(Uint32, Pointer<Utf16>, Pointer<Utf16>);
typedef MsiSetTargetPathWDart = int Function(int, Pointer<Utf16>, Pointer<Utf16>);
final MsiSetTargetPathW = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiSetTargetPathWNative, MsiSetTargetPathWDart>('MsiSetTargetPathW');
// hInstall : MSIHANDLE -> Uint32
// szFolder : LPCWSTR -> Pointer<Utf16>
// szFolderPath : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiSetTargetPathW(
hInstall: DWORD; // MSIHANDLE
szFolder: PWideChar; // LPCWSTR
szFolderPath: PWideChar // LPCWSTR
): DWORD; stdcall;
external 'msi.dll' name 'MsiSetTargetPathW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiSetTargetPathW"
c_MsiSetTargetPathW :: Word32 -> CWString -> CWString -> IO Word32
-- hInstall : MSIHANDLE -> Word32
-- szFolder : LPCWSTR -> CWString
-- szFolderPath : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msisettargetpathw =
foreign "MsiSetTargetPathW"
(uint32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* hInstall : MSIHANDLE -> uint32_t *)
(* szFolder : LPCWSTR -> (ptr uint16_t) *)
(* szFolderPath : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)
(cffi:defcfun ("MsiSetTargetPathW" msi-set-target-path-w :convention :stdcall) :uint32
(h-install :uint32) ; MSIHANDLE
(sz-folder (:string :encoding :utf-16le)) ; LPCWSTR
(sz-folder-path (:string :encoding :utf-16le))) ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiSetTargetPathW = Win32::API::More->new('msi',
'DWORD MsiSetTargetPathW(DWORD hInstall, LPCWSTR szFolder, LPCWSTR szFolderPath)');
# my $ret = $MsiSetTargetPathW->Call($hInstall, $szFolder, $szFolderPath);
# hInstall : MSIHANDLE -> DWORD
# szFolder : LPCWSTR -> LPCWSTR
# szFolderPath : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f MsiSetTargetPathA (ANSI版) — フォルダーのインストール先ターゲットパスを設定する(ANSI版)。