ホーム › System.ApplicationInstallationAndServicing › MsiProcessAdvertiseScriptA

MsiProcessAdvertiseScriptA

関数

アドバタイズスクリプトを処理し登録を実行する(ANSI版)。

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

シグネチャ

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

DWORD MsiProcessAdvertiseScriptA(
    LPCSTR szScriptFile,
    LPCSTR szIconFolder,   // optional
    HKEY hRegData,   // optional
    BOOL fShortcuts,
    BOOL fRemoveItems
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

MsiProcessAdvertiseScript 関数は、アドバタイズスクリプトファイルを処理して指定された場所へ反映します。(ANSI)

戻り値

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

解説(Remarks)

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

メモ

msi.h ヘッダーは MsiProcessAdvertiseScript を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 MsiProcessAdvertiseScriptA(
    LPCSTR szScriptFile,
    LPCSTR szIconFolder,   // optional
    HKEY hRegData,   // optional
    BOOL fShortcuts,
    BOOL fRemoveItems
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiProcessAdvertiseScriptA(
    [MarshalAs(UnmanagedType.LPStr)] string szScriptFile,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szIconFolder,   // LPCSTR optional
    IntPtr hRegData,   // HKEY optional
    bool fShortcuts,   // BOOL
    bool fRemoveItems   // BOOL
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiProcessAdvertiseScriptA(
    <MarshalAs(UnmanagedType.LPStr)> szScriptFile As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szIconFolder As String,   ' LPCSTR optional
    hRegData As IntPtr,   ' HKEY optional
    fShortcuts As Boolean,   ' BOOL
    fRemoveItems As Boolean   ' BOOL
) As UInteger
End Function

' szScriptFile : LPCSTR
' szIconFolder : LPCSTR optional
' hRegData : HKEY optional
' fShortcuts : BOOL
' fRemoveItems : BOOL
Declare PtrSafe Function MsiProcessAdvertiseScriptA Lib "msi" ( _
    ByVal szScriptFile As String, _
    ByVal szIconFolder As String, _
    ByVal hRegData As LongPtr, _
    ByVal fShortcuts As Long, _
    ByVal fRemoveItems As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiProcessAdvertiseScriptA = ctypes.windll.msi.MsiProcessAdvertiseScriptA
MsiProcessAdvertiseScriptA.restype = wintypes.DWORD
MsiProcessAdvertiseScriptA.argtypes = [
    wintypes.LPCSTR,  # szScriptFile : LPCSTR
    wintypes.LPCSTR,  # szIconFolder : LPCSTR optional
    wintypes.HANDLE,  # hRegData : HKEY optional
    wintypes.BOOL,  # fShortcuts : BOOL
    wintypes.BOOL,  # fRemoveItems : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiProcessAdvertiseScriptA = Fiddle::Function.new(
  lib['MsiProcessAdvertiseScriptA'],
  [
    Fiddle::TYPE_VOIDP,  # szScriptFile : LPCSTR
    Fiddle::TYPE_VOIDP,  # szIconFolder : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # hRegData : HKEY optional
    Fiddle::TYPE_INT,  # fShortcuts : BOOL
    Fiddle::TYPE_INT,  # fRemoveItems : BOOL
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiProcessAdvertiseScriptA(
        szScriptFile: *const u8,  // LPCSTR
        szIconFolder: *const u8,  // LPCSTR 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.Ansi)]
public static extern uint MsiProcessAdvertiseScriptA([MarshalAs(UnmanagedType.LPStr)] string szScriptFile, [MarshalAs(UnmanagedType.LPStr)] string szIconFolder, IntPtr hRegData, bool fShortcuts, bool fRemoveItems);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiProcessAdvertiseScriptA' -Namespace Win32 -PassThru
# $api::MsiProcessAdvertiseScriptA(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)

#uselib "msi.dll"
#func global MsiProcessAdvertiseScriptA "MsiProcessAdvertiseScriptA" sptr, sptr, sptr, sptr, sptr
; MsiProcessAdvertiseScriptA szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems   ; 戻り値は stat
; szScriptFile : LPCSTR -> "sptr"
; szIconFolder : LPCSTR optional -> "sptr"
; hRegData : HKEY optional -> "sptr"
; fShortcuts : BOOL -> "sptr"
; fRemoveItems : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "msi.dll"
#cfunc global MsiProcessAdvertiseScriptA "MsiProcessAdvertiseScriptA" str, str, sptr, int, int
; res = MsiProcessAdvertiseScriptA(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
; szScriptFile : LPCSTR -> "str"
; szIconFolder : LPCSTR optional -> "str"
; hRegData : HKEY optional -> "sptr"
; fShortcuts : BOOL -> "int"
; fRemoveItems : BOOL -> "int"

; DWORD MsiProcessAdvertiseScriptA(LPCSTR szScriptFile, LPCSTR szIconFolder, HKEY hRegData, BOOL fShortcuts, BOOL fRemoveItems)
#uselib "msi.dll"
#cfunc global MsiProcessAdvertiseScriptA "MsiProcessAdvertiseScriptA" str, str, intptr, int, int
; res = MsiProcessAdvertiseScriptA(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
; szScriptFile : LPCSTR -> "str"
; szIconFolder : LPCSTR optional -> "str"
; hRegData : HKEY optional -> "intptr"
; fShortcuts : BOOL -> "int"
; fRemoveItems : BOOL -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiProcessAdvertiseScriptA = msi.NewProc("MsiProcessAdvertiseScriptA")
)

// szScriptFile (LPCSTR), szIconFolder (LPCSTR optional), hRegData (HKEY optional), fShortcuts (BOOL), fRemoveItems (BOOL)
r1, _, err := procMsiProcessAdvertiseScriptA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szScriptFile))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szIconFolder))),
	uintptr(hRegData),
	uintptr(fShortcuts),
	uintptr(fRemoveItems),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function MsiProcessAdvertiseScriptA(
  szScriptFile: PAnsiChar;   // LPCSTR
  szIconFolder: PAnsiChar;   // LPCSTR optional
  hRegData: THandle;   // HKEY optional
  fShortcuts: BOOL;   // BOOL
  fRemoveItems: BOOL   // BOOL
): DWORD; stdcall;
  external 'msi.dll' name 'MsiProcessAdvertiseScriptA';

result := DllCall("msi\MsiProcessAdvertiseScriptA"
    , "AStr", szScriptFile   ; LPCSTR
    , "AStr", szIconFolder   ; LPCSTR optional
    , "Ptr", hRegData   ; HKEY optional
    , "Int", fShortcuts   ; BOOL
    , "Int", fRemoveItems   ; BOOL
    , "UInt")   ; return: DWORD

●MsiProcessAdvertiseScriptA(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems) = DLL("msi.dll", "dword MsiProcessAdvertiseScriptA(char*, char*, void*, bool, bool)")
# 呼び出し: MsiProcessAdvertiseScriptA(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
# szScriptFile : LPCSTR -> "char*"
# szIconFolder : LPCSTR optional -> "char*"
# hRegData : HKEY optional -> "void*"
# fShortcuts : BOOL -> "bool"
# fRemoveItems : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "msi" fn MsiProcessAdvertiseScriptA(
    szScriptFile: [*c]const u8, // LPCSTR
    szIconFolder: [*c]const u8, // LPCSTR optional
    hRegData: ?*anyopaque, // HKEY optional
    fShortcuts: i32, // BOOL
    fRemoveItems: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;

proc MsiProcessAdvertiseScriptA(
    szScriptFile: cstring,  # LPCSTR
    szIconFolder: cstring,  # LPCSTR optional
    hRegData: pointer,  # HKEY optional
    fShortcuts: int32,  # BOOL
    fRemoveItems: int32  # BOOL
): uint32 {.importc: "MsiProcessAdvertiseScriptA", stdcall, dynlib: "msi.dll".}

pragma(lib, "msi");
extern(Windows)
uint MsiProcessAdvertiseScriptA(
    const(char)* szScriptFile,   // LPCSTR
    const(char)* szIconFolder,   // LPCSTR optional
    void* hRegData,   // HKEY optional
    int fShortcuts,   // BOOL
    int fRemoveItems   // BOOL
);

ccall((:MsiProcessAdvertiseScriptA, "msi.dll"), stdcall, UInt32,
      (Cstring, Cstring, Ptr{Cvoid}, Int32, Int32),
      szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
# szScriptFile : LPCSTR -> Cstring
# szIconFolder : LPCSTR optional -> Cstring
# hRegData : HKEY optional -> Ptr{Cvoid}
# fShortcuts : BOOL -> Int32
# fRemoveItems : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiProcessAdvertiseScriptA(
    const char* szScriptFile,
    const char* szIconFolder,
    void* hRegData,
    int32_t fShortcuts,
    int32_t fRemoveItems);
]]
local msi = ffi.load("msi")
-- msi.MsiProcessAdvertiseScriptA(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
-- szScriptFile : LPCSTR
-- szIconFolder : LPCSTR optional
-- hRegData : HKEY optional
-- fShortcuts : BOOL
-- fRemoveItems : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiProcessAdvertiseScriptA = lib.func('__stdcall', 'MsiProcessAdvertiseScriptA', 'uint32_t', ['str', 'str', 'void *', 'int32_t', 'int32_t']);
// MsiProcessAdvertiseScriptA(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
// szScriptFile : LPCSTR -> 'str'
// szIconFolder : LPCSTR optional -> 'str'
// hRegData : HKEY optional -> 'void *'
// fShortcuts : BOOL -> 'int32_t'
// fRemoveItems : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("msi.dll", {
  MsiProcessAdvertiseScriptA: { parameters: ["buffer", "buffer", "pointer", "i32", "i32"], result: "u32" },
});
// lib.symbols.MsiProcessAdvertiseScriptA(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems)
// szScriptFile : LPCSTR -> "buffer"
// szIconFolder : LPCSTR optional -> "buffer"
// hRegData : HKEY optional -> "pointer"
// fShortcuts : BOOL -> "i32"
// fRemoveItems : BOOL -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiProcessAdvertiseScriptA(
    const char* szScriptFile,
    const char* szIconFolder,
    void* hRegData,
    int32_t fShortcuts,
    int32_t fRemoveItems);
C, "msi.dll");
// $ffi->MsiProcessAdvertiseScriptA(szScriptFile, szIconFolder, hRegData, fShortcuts, fRemoveItems);
// szScriptFile : LPCSTR
// szIconFolder : LPCSTR 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.ASCII_OPTIONS);
    int MsiProcessAdvertiseScriptA(
        String szScriptFile,   // LPCSTR
        String szIconFolder,   // LPCSTR optional
        Pointer hRegData,   // HKEY optional
        boolean fShortcuts,   // BOOL
        boolean fRemoveItems   // BOOL
    );
}

@[Link("msi")]
lib Libmsi
  fun MsiProcessAdvertiseScriptA = MsiProcessAdvertiseScriptA(
    szScriptFile : UInt8*,   # LPCSTR
    szIconFolder : UInt8*,   # LPCSTR 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 MsiProcessAdvertiseScriptANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Int32, Int32);
typedef MsiProcessAdvertiseScriptADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, int, int);
final MsiProcessAdvertiseScriptA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiProcessAdvertiseScriptANative, MsiProcessAdvertiseScriptADart>('MsiProcessAdvertiseScriptA');
// szScriptFile : LPCSTR -> Pointer<Utf8>
// szIconFolder : LPCSTR optional -> Pointer<Utf8>
// hRegData : HKEY optional -> Pointer<Void>
// fShortcuts : BOOL -> Int32
// fRemoveItems : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function MsiProcessAdvertiseScriptA(
  szScriptFile: PAnsiChar;   // LPCSTR
  szIconFolder: PAnsiChar;   // LPCSTR optional
  hRegData: THandle;   // HKEY optional
  fShortcuts: BOOL;   // BOOL
  fRemoveItems: BOOL   // BOOL
): DWORD; stdcall;
  external 'msi.dll' name 'MsiProcessAdvertiseScriptA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

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

open Ctypes
open Foreign

let msiprocessadvertisescripta =
  foreign "MsiProcessAdvertiseScriptA"
    (string @-> string @-> (ptr void) @-> int32_t @-> int32_t @-> returning uint32_t)
(* szScriptFile : LPCSTR -> string *)
(* szIconFolder : LPCSTR optional -> string *)
(* 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 ("MsiProcessAdvertiseScriptA" msi-process-advertise-script-a :convention :stdcall) :uint32
  (sz-script-file :string)   ; LPCSTR
  (sz-icon-folder :string)   ; LPCSTR 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 $MsiProcessAdvertiseScriptA = Win32::API::More->new('msi',
    'DWORD MsiProcessAdvertiseScriptA(LPCSTR szScriptFile, LPCSTR szIconFolder, HANDLE hRegData, BOOL fShortcuts, BOOL fRemoveItems)');
# my $ret = $MsiProcessAdvertiseScriptA->Call($szScriptFile, $szIconFolder, $hRegData, $fShortcuts, $fRemoveItems);
# szScriptFile : LPCSTR -> LPCSTR
# szIconFolder : LPCSTR optional -> LPCSTR
# hRegData : HKEY optional -> HANDLE
# fShortcuts : BOOL -> BOOL
# fRemoveItems : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。