Win32 API 日本語リファレンス
ホームSystem.ApplicationInstallationAndServicing › MsiProcessAdvertiseScriptW

MsiProcessAdvertiseScriptW

関数
アドバタイズスクリプトを処理し登録を実行する(Unicode版)。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiProcessAdvertiseScriptW(
    LPCWSTR szScriptFile,
    LPCWSTR szIconFolder,   // optional
    HKEY hRegData,   // optional
    BOOL fShortcuts,
    BOOL fRemoveItems
);

パラメーター

名前方向説明
szScriptFileLPCWSTRinMsiAdvertiseProduct または MsiAdvertiseProductEx によって生成されたスクリプト ファイルへのフル パスです。
szIconFolderLPCWSTRinoptionalアドバタイズされるアイコン ファイルおよびトランスフォーム ファイルが格納されるフォルダーへの省略可能なパスです。このパラメーターが NULL の場合、アイコン ファイルおよびトランスフォーム ファイルは書き込まれません。
hRegDataHKEYinoptionalレジストリ データの書き込み先となるレジストリ キーです。このパラメーターが NULL の場合、インストーラーは、アドバタイズがユーザー単位かコンピューター単位かに応じて適切なキーの下にレジストリ データを書き込みます。このパラメーターが NULL 以外の場合、スクリプトは通常の場所ではなく、指定されたレジストリ キーの下にレジストリ データを書き込みます。この場合、アプリケーションはユーザーに対してアドバタイズされません。
fShortcutsBOOLinショートカットを作成する場合は TRUE を指定します。 SHGetSpecialFolderLocation によって特殊フォルダーが返された場合、そのフォルダーにショートカットが格納されます。
fRemoveItemsBOOLin指定された項目を作成するのではなく削除する場合は TRUE を指定します。

戻り値の型: DWORD

公式ドキュメント

MsiProcessAdvertiseScript 関数は、アドバタイズ スクリプト ファイルを処理し、指定された場所に展開します。(Unicode)

戻り値

意味
ERROR_SUCCESS
関数は正常に完了しました。
ERROR_ACCESS_DENIED
呼び出し元のプロセスが LocalSystem アカウントで実行されていませんでした。
アクションに関連するエラー
エラー コード を参照してください。
初期化エラー
初期化に関連するエラーが発生しました。
ERROR_CALL_NOT_IMPLEMENTED
この関数は、このプラットフォームでは使用できません。

解説(Remarks)

この関数を呼び出すプロセスは、LocalSystem アカウントで実行されている必要があります。対象ユーザーに対してユーザー単位のインストール用にアプリケーションをアドバタイズするには、この関数を呼び出すスレッドが対象ユーザーになりすます (impersonate) 必要があります。この関数を呼び出すスレッドが対象ユーザーになりすましていない場合、アプリケーションはすべてのユーザーに対して、昇格された特権でのインストール用にアドバタイズされます。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiProcessAdvertiseScriptW(
    LPCWSTR szScriptFile,
    LPCWSTR szIconFolder,   // optional
    HKEY hRegData,   // optional
    BOOL fShortcuts,
    BOOL fRemoveItems
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiProcessAdvertiseScriptW(
    [MarshalAs(UnmanagedType.LPWStr)] string szScriptFile,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string szIconFolder,   // LPCWSTR optional
    IntPtr hRegData,   // HKEY optional
    bool fShortcuts,   // BOOL
    bool fRemoveItems   // BOOL
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiProcessAdvertiseScriptW(
    <MarshalAs(UnmanagedType.LPWStr)> szScriptFile As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> szIconFolder As String,   ' LPCWSTR optional
    hRegData As IntPtr,   ' HKEY optional
    fShortcuts As Boolean,   ' BOOL
    fRemoveItems As Boolean   ' BOOL
) As UInteger
End Function
' szScriptFile : LPCWSTR
' szIconFolder : LPCWSTR optional
' hRegData : HKEY optional
' fShortcuts : BOOL
' fRemoveItems : BOOL
Declare PtrSafe Function MsiProcessAdvertiseScriptW Lib "msi" ( _
    ByVal szScriptFile As LongPtr, _
    ByVal szIconFolder As LongPtr, _
    ByVal hRegData As LongPtr, _
    ByVal fShortcuts As Long, _
    ByVal fRemoveItems 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

MsiProcessAdvertiseScriptW = ctypes.windll.msi.MsiProcessAdvertiseScriptW
MsiProcessAdvertiseScriptW.restype = wintypes.DWORD
MsiProcessAdvertiseScriptW.argtypes = [
    wintypes.LPCWSTR,  # szScriptFile : LPCWSTR
    wintypes.LPCWSTR,  # szIconFolder : LPCWSTR optional
    wintypes.HANDLE,  # hRegData : HKEY optional
    wintypes.BOOL,  # fShortcuts : BOOL
    wintypes.BOOL,  # fRemoveItems : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiProcessAdvertiseScriptW = Fiddle::Function.new(
  lib['MsiProcessAdvertiseScriptW'],
  [
    Fiddle::TYPE_VOIDP,  # szScriptFile : LPCWSTR
    Fiddle::TYPE_VOIDP,  # szIconFolder : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # hRegData : HKEY optional
    Fiddle::TYPE_INT,  # fShortcuts : BOOL
    Fiddle::TYPE_INT,  # fRemoveItems : BOOL
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msi")]
extern "system" {
    fn MsiProcessAdvertiseScriptW(
        szScriptFile: *const u16,  // LPCWSTR
        szIconFolder: *const u16,  // LPCWSTR optional
        hRegData: *mut core::ffi::c_void,  // HKEY optional
        fShortcuts: i32,  // BOOL
        fRemoveItems: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiProcessAdvertiseScriptW([MarshalAs(UnmanagedType.LPWStr)] string szScriptFile, [MarshalAs(UnmanagedType.LPWStr)] string szIconFolder, IntPtr hRegData, bool fShortcuts, bool fRemoveItems);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiProcessAdvertiseScriptW' -Namespace Win32 -PassThru
# $api::MsiProcessAdvertiseScriptW(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
#uselib "msi.dll"
#func global MsiProcessAdvertiseScriptW "MsiProcessAdvertiseScriptW" wptr, wptr, wptr, wptr, wptr
; MsiProcessAdvertiseScriptW szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems   ; 戻り値は stat
; szScriptFile : LPCWSTR -> "wptr"
; szIconFolder : LPCWSTR optional -> "wptr"
; hRegData : HKEY optional -> "wptr"
; fShortcuts : BOOL -> "wptr"
; fRemoveItems : BOOL -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiProcessAdvertiseScriptW "MsiProcessAdvertiseScriptW" wstr, wstr, sptr, int, int
; res = MsiProcessAdvertiseScriptW(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
; szScriptFile : LPCWSTR -> "wstr"
; szIconFolder : LPCWSTR optional -> "wstr"
; hRegData : HKEY optional -> "sptr"
; fShortcuts : BOOL -> "int"
; fRemoveItems : BOOL -> "int"
; DWORD MsiProcessAdvertiseScriptW(LPCWSTR szScriptFile, LPCWSTR szIconFolder, HKEY hRegData, BOOL fShortcuts, BOOL fRemoveItems)
#uselib "msi.dll"
#cfunc global MsiProcessAdvertiseScriptW "MsiProcessAdvertiseScriptW" wstr, wstr, intptr, int, int
; res = MsiProcessAdvertiseScriptW(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
; szScriptFile : LPCWSTR -> "wstr"
; szIconFolder : LPCWSTR optional -> "wstr"
; hRegData : HKEY optional -> "intptr"
; fShortcuts : BOOL -> "int"
; fRemoveItems : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiProcessAdvertiseScriptW = msi.NewProc("MsiProcessAdvertiseScriptW")
)

// szScriptFile (LPCWSTR), szIconFolder (LPCWSTR optional), hRegData (HKEY optional), fShortcuts (BOOL), fRemoveItems (BOOL)
r1, _, err := procMsiProcessAdvertiseScriptW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szScriptFile))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szIconFolder))),
	uintptr(hRegData),
	uintptr(fShortcuts),
	uintptr(fRemoveItems),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiProcessAdvertiseScriptW(
  szScriptFile: PWideChar;   // LPCWSTR
  szIconFolder: PWideChar;   // LPCWSTR optional
  hRegData: THandle;   // HKEY optional
  fShortcuts: BOOL;   // BOOL
  fRemoveItems: BOOL   // BOOL
): DWORD; stdcall;
  external 'msi.dll' name 'MsiProcessAdvertiseScriptW';
result := DllCall("msi\MsiProcessAdvertiseScriptW"
    , "WStr", szScriptFile   ; LPCWSTR
    , "WStr", szIconFolder   ; LPCWSTR optional
    , "Ptr", hRegData   ; HKEY optional
    , "Int", fShortcuts   ; BOOL
    , "Int", fRemoveItems   ; BOOL
    , "UInt")   ; return: DWORD
●MsiProcessAdvertiseScriptW(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems) = DLL("msi.dll", "dword MsiProcessAdvertiseScriptW(char*, char*, void*, bool, bool)")
# 呼び出し: MsiProcessAdvertiseScriptW(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
# szScriptFile : LPCWSTR -> "char*"
# szIconFolder : LPCWSTR optional -> "char*"
# hRegData : HKEY optional -> "void*"
# fShortcuts : BOOL -> "bool"
# fRemoveItems : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "msi" fn MsiProcessAdvertiseScriptW(
    szScriptFile: [*c]const u16, // LPCWSTR
    szIconFolder: [*c]const u16, // LPCWSTR optional
    hRegData: ?*anyopaque, // HKEY optional
    fShortcuts: i32, // BOOL
    fRemoveItems: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiProcessAdvertiseScriptW(
    szScriptFile: WideCString,  # LPCWSTR
    szIconFolder: WideCString,  # LPCWSTR optional
    hRegData: pointer,  # HKEY optional
    fShortcuts: int32,  # BOOL
    fRemoveItems: int32  # BOOL
): uint32 {.importc: "MsiProcessAdvertiseScriptW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
uint MsiProcessAdvertiseScriptW(
    const(wchar)* szScriptFile,   // LPCWSTR
    const(wchar)* szIconFolder,   // LPCWSTR optional
    void* hRegData,   // HKEY optional
    int fShortcuts,   // BOOL
    int fRemoveItems   // BOOL
);
ccall((:MsiProcessAdvertiseScriptW, "msi.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, Ptr{Cvoid}, Int32, Int32),
      szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
# szScriptFile : LPCWSTR -> Cwstring
# szIconFolder : LPCWSTR optional -> Cwstring
# hRegData : HKEY optional -> Ptr{Cvoid}
# fShortcuts : BOOL -> Int32
# fRemoveItems : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiProcessAdvertiseScriptW(
    const uint16_t* szScriptFile,
    const uint16_t* szIconFolder,
    void* hRegData,
    int32_t fShortcuts,
    int32_t fRemoveItems);
]]
local msi = ffi.load("msi")
-- msi.MsiProcessAdvertiseScriptW(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
-- szScriptFile : LPCWSTR
-- szIconFolder : LPCWSTR optional
-- hRegData : HKEY optional
-- fShortcuts : BOOL
-- fRemoveItems : BOOL
-- 構造体/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 MsiProcessAdvertiseScriptW = lib.func('__stdcall', 'MsiProcessAdvertiseScriptW', 'uint32_t', ['str16', 'str16', 'void *', 'int32_t', 'int32_t']);
// MsiProcessAdvertiseScriptW(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
// szScriptFile : LPCWSTR -> 'str16'
// szIconFolder : LPCWSTR optional -> 'str16'
// hRegData : HKEY optional -> 'void *'
// fShortcuts : BOOL -> 'int32_t'
// fRemoveItems : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiProcessAdvertiseScriptW: { parameters: ["buffer", "buffer", "pointer", "i32", "i32"], result: "u32" },
});
// lib.symbols.MsiProcessAdvertiseScriptW(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
// szScriptFile : LPCWSTR -> "buffer"
// szIconFolder : LPCWSTR optional -> "buffer"
// hRegData : HKEY optional -> "pointer"
// fShortcuts : BOOL -> "i32"
// fRemoveItems : BOOL -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiProcessAdvertiseScriptW(
    const uint16_t* szScriptFile,
    const uint16_t* szIconFolder,
    void* hRegData,
    int32_t fShortcuts,
    int32_t fRemoveItems);
C, "msi.dll");
// $ffi->MsiProcessAdvertiseScriptW(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems);
// szScriptFile : LPCWSTR
// szIconFolder : LPCWSTR optional
// hRegData : HKEY optional
// fShortcuts : BOOL
// fRemoveItems : BOOL
// 構造体/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 MsiProcessAdvertiseScriptW(
        WString szScriptFile,   // LPCWSTR
        WString szIconFolder,   // LPCWSTR optional
        Pointer hRegData,   // HKEY optional
        boolean fShortcuts,   // BOOL
        boolean fRemoveItems   // BOOL
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiProcessAdvertiseScriptW = MsiProcessAdvertiseScriptW(
    szScriptFile : UInt16*,   # LPCWSTR
    szIconFolder : UInt16*,   # LPCWSTR optional
    hRegData : Void*,   # HKEY optional
    fShortcuts : Int32,   # BOOL
    fRemoveItems : Int32   # BOOL
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiProcessAdvertiseScriptWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Int32, Int32);
typedef MsiProcessAdvertiseScriptWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, int, int);
final MsiProcessAdvertiseScriptW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiProcessAdvertiseScriptWNative, MsiProcessAdvertiseScriptWDart>('MsiProcessAdvertiseScriptW');
// szScriptFile : LPCWSTR -> Pointer<Utf16>
// szIconFolder : LPCWSTR optional -> Pointer<Utf16>
// hRegData : HKEY optional -> Pointer<Void>
// fShortcuts : BOOL -> Int32
// fRemoveItems : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiProcessAdvertiseScriptW(
  szScriptFile: PWideChar;   // LPCWSTR
  szIconFolder: PWideChar;   // LPCWSTR optional
  hRegData: THandle;   // HKEY optional
  fShortcuts: BOOL;   // BOOL
  fRemoveItems: BOOL   // BOOL
): DWORD; stdcall;
  external 'msi.dll' name 'MsiProcessAdvertiseScriptW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiProcessAdvertiseScriptW"
  c_MsiProcessAdvertiseScriptW :: CWString -> CWString -> Ptr () -> CInt -> CInt -> IO Word32
-- szScriptFile : LPCWSTR -> CWString
-- szIconFolder : LPCWSTR optional -> CWString
-- hRegData : HKEY optional -> Ptr ()
-- fShortcuts : BOOL -> CInt
-- fRemoveItems : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msiprocessadvertisescriptw =
  foreign "MsiProcessAdvertiseScriptW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> int32_t @-> int32_t @-> returning uint32_t)
(* szScriptFile : LPCWSTR -> (ptr uint16_t) *)
(* szIconFolder : LPCWSTR optional -> (ptr uint16_t) *)
(* hRegData : HKEY optional -> (ptr void) *)
(* fShortcuts : BOOL -> int32_t *)
(* fRemoveItems : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiProcessAdvertiseScriptW" msi-process-advertise-script-w :convention :stdcall) :uint32
  (sz-script-file (:string :encoding :utf-16le))   ; LPCWSTR
  (sz-icon-folder (:string :encoding :utf-16le))   ; LPCWSTR optional
  (h-reg-data :pointer)   ; HKEY optional
  (f-shortcuts :int32)   ; BOOL
  (f-remove-items :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiProcessAdvertiseScriptW = Win32::API::More->new('msi',
    'DWORD MsiProcessAdvertiseScriptW(LPCWSTR szScriptFile, LPCWSTR szIconFolder, HANDLE hRegData, BOOL fShortcuts, BOOL fRemoveItems)');
# my $ret = $MsiProcessAdvertiseScriptW->Call($szScriptFile, $szIconFolder, $hRegData, $fShortcuts, $fRemoveItems);
# szScriptFile : LPCWSTR -> LPCWSTR
# szIconFolder : LPCWSTR optional -> LPCWSTR
# hRegData : HKEY optional -> HANDLE
# fShortcuts : BOOL -> BOOL
# fRemoveItems : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い