MsiAdvertiseScriptW
関数シグネチャ
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiAdvertiseScriptW(
LPCWSTR szScriptFile,
DWORD dwFlags,
HKEY* phRegData, // optional
BOOL fRemoveItems
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| szScriptFile | LPCWSTR | in | MsiAdvertiseProduct または MsiAdvertiseProductEx によって生成されたスクリプトファイルへのフルパス。 | ||||||||||||||||||||
| dwFlags | DWORD | in | アドバタイズを制御する SCRIPTFLAGS の以下のビットフラグ。dwFlags の値は、次の値の組み合わせを指定できます。
| ||||||||||||||||||||
| phRegData | HKEY* | inoptional | レジストリデータに関する一時情報を書き込むレジストリキー。このパラメーターが null の場合、レジストリデータは、アドバタイズがユーザー単位かコンピューター単位かに応じて適切なキーの下に配置されます。このパラメーターが null 以外の場合、スクリプトは通常の場所ではなく、指定されたレジストリキーの下にレジストリデータを書き込みます。この場合、アプリケーションはユーザーに対してアドバタイズされません。 なお、このレジストリキーは、ユーザーまたはコンピューターに対する製品のアドバタイズを生成する際には使用できません。これは、レジストリキーの提供者が通常そのキーを削除するためです。このレジストリキーは、シェル、クラス、および .msi 構成情報の通常のレジストリの場所の外部に位置し、HKEY_CLASSES_ROOT の下にはありません。このレジストリキーは、スクリプト内のレジストリデータに関する一時情報を取得することのみを目的としています。 | ||||||||||||||||||||
| fRemoveItems | BOOL | in | 指定された項目を作成するのではなく削除する場合は TRUE。 |
戻り値の型: DWORD
公式ドキュメント
MsiAdvertiseScript 関数は、アドバタイズ用のスクリプトファイルを指定された場所にコピーします。(Unicode)
戻り値
| 値 | 意味 |
|---|---|
| 関数が正常に完了しました。 | |
| 呼び出し元のプロセスが LocalSystem アカウントで実行されていませんでした。 | |
|
エラーコードを参照してください。 |
| 初期化に関連するエラーが発生しました。 | |
| この関数は Windows 2000 および Windows XP でのみ使用できます。 |
解説(Remarks)
この関数を呼び出すプロセスは、LocalSystem アカウントで実行されている必要があります。対象のユーザーに対してユーザー単位のインストール用にアプリケーションをアドバタイズするには、この関数を呼び出すスレッドが対象のユーザーになりすます必要があります。この関数を呼び出すスレッドが対象のユーザーになりすましていない場合、アプリケーションは昇格された特権でのインストール用にすべてのユーザーに対してアドバタイズされます。
msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiAdvertiseScript を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiAdvertiseScriptW(
LPCWSTR szScriptFile,
DWORD dwFlags,
HKEY* phRegData, // optional
BOOL fRemoveItems
);[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiAdvertiseScriptW(
[MarshalAs(UnmanagedType.LPWStr)] string szScriptFile, // LPCWSTR
uint dwFlags, // DWORD
IntPtr phRegData, // HKEY* optional
bool fRemoveItems // BOOL
);<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiAdvertiseScriptW(
<MarshalAs(UnmanagedType.LPWStr)> szScriptFile As String, ' LPCWSTR
dwFlags As UInteger, ' DWORD
phRegData As IntPtr, ' HKEY* optional
fRemoveItems As Boolean ' BOOL
) As UInteger
End Function' szScriptFile : LPCWSTR
' dwFlags : DWORD
' phRegData : HKEY* optional
' fRemoveItems : BOOL
Declare PtrSafe Function MsiAdvertiseScriptW Lib "msi" ( _
ByVal szScriptFile As LongPtr, _
ByVal dwFlags As Long, _
ByVal phRegData As LongPtr, _
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
MsiAdvertiseScriptW = ctypes.windll.msi.MsiAdvertiseScriptW
MsiAdvertiseScriptW.restype = wintypes.DWORD
MsiAdvertiseScriptW.argtypes = [
wintypes.LPCWSTR, # szScriptFile : LPCWSTR
wintypes.DWORD, # dwFlags : DWORD
ctypes.c_void_p, # phRegData : HKEY* optional
wintypes.BOOL, # fRemoveItems : BOOL
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiAdvertiseScriptW = Fiddle::Function.new(
lib['MsiAdvertiseScriptW'],
[
Fiddle::TYPE_VOIDP, # szScriptFile : LPCWSTR
-Fiddle::TYPE_INT, # dwFlags : DWORD
Fiddle::TYPE_VOIDP, # phRegData : HKEY* optional
Fiddle::TYPE_INT, # fRemoveItems : BOOL
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "msi")]
extern "system" {
fn MsiAdvertiseScriptW(
szScriptFile: *const u16, // LPCWSTR
dwFlags: u32, // DWORD
phRegData: *mut *mut core::ffi::c_void, // HKEY* optional
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 MsiAdvertiseScriptW([MarshalAs(UnmanagedType.LPWStr)] string szScriptFile, uint dwFlags, IntPtr phRegData, bool fRemoveItems);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiAdvertiseScriptW' -Namespace Win32 -PassThru
# $api::MsiAdvertiseScriptW(szScriptFile, dwFlags, phRegData, fRemoveItems)#uselib "msi.dll"
#func global MsiAdvertiseScriptW "MsiAdvertiseScriptW" wptr, wptr, wptr, wptr
; MsiAdvertiseScriptW szScriptFile, dwFlags, phRegData, fRemoveItems ; 戻り値は stat
; szScriptFile : LPCWSTR -> "wptr"
; dwFlags : DWORD -> "wptr"
; phRegData : HKEY* optional -> "wptr"
; fRemoveItems : BOOL -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "msi.dll"
#cfunc global MsiAdvertiseScriptW "MsiAdvertiseScriptW" wstr, int, sptr, int
; res = MsiAdvertiseScriptW(szScriptFile, dwFlags, phRegData, fRemoveItems)
; szScriptFile : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; phRegData : HKEY* optional -> "sptr"
; fRemoveItems : BOOL -> "int"; DWORD MsiAdvertiseScriptW(LPCWSTR szScriptFile, DWORD dwFlags, HKEY* phRegData, BOOL fRemoveItems)
#uselib "msi.dll"
#cfunc global MsiAdvertiseScriptW "MsiAdvertiseScriptW" wstr, int, intptr, int
; res = MsiAdvertiseScriptW(szScriptFile, dwFlags, phRegData, fRemoveItems)
; szScriptFile : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; phRegData : HKEY* optional -> "intptr"
; fRemoveItems : BOOL -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiAdvertiseScriptW = msi.NewProc("MsiAdvertiseScriptW")
)
// szScriptFile (LPCWSTR), dwFlags (DWORD), phRegData (HKEY* optional), fRemoveItems (BOOL)
r1, _, err := procMsiAdvertiseScriptW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szScriptFile))),
uintptr(dwFlags),
uintptr(phRegData),
uintptr(fRemoveItems),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiAdvertiseScriptW(
szScriptFile: PWideChar; // LPCWSTR
dwFlags: DWORD; // DWORD
phRegData: Pointer; // HKEY* optional
fRemoveItems: BOOL // BOOL
): DWORD; stdcall;
external 'msi.dll' name 'MsiAdvertiseScriptW';result := DllCall("msi\MsiAdvertiseScriptW"
, "WStr", szScriptFile ; LPCWSTR
, "UInt", dwFlags ; DWORD
, "Ptr", phRegData ; HKEY* optional
, "Int", fRemoveItems ; BOOL
, "UInt") ; return: DWORD●MsiAdvertiseScriptW(szScriptFile, dwFlags, phRegData, fRemoveItems) = DLL("msi.dll", "dword MsiAdvertiseScriptW(char*, dword, void*, bool)")
# 呼び出し: MsiAdvertiseScriptW(szScriptFile, dwFlags, phRegData, fRemoveItems)
# szScriptFile : LPCWSTR -> "char*"
# dwFlags : DWORD -> "dword"
# phRegData : HKEY* optional -> "void*"
# fRemoveItems : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "msi" fn MsiAdvertiseScriptW(
szScriptFile: [*c]const u16, // LPCWSTR
dwFlags: u32, // DWORD
phRegData: ?*anyopaque, // HKEY* optional
fRemoveItems: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc MsiAdvertiseScriptW(
szScriptFile: WideCString, # LPCWSTR
dwFlags: uint32, # DWORD
phRegData: pointer, # HKEY* optional
fRemoveItems: int32 # BOOL
): uint32 {.importc: "MsiAdvertiseScriptW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "msi");
extern(Windows)
uint MsiAdvertiseScriptW(
const(wchar)* szScriptFile, // LPCWSTR
uint dwFlags, // DWORD
void* phRegData, // HKEY* optional
int fRemoveItems // BOOL
);ccall((:MsiAdvertiseScriptW, "msi.dll"), stdcall, UInt32,
(Cwstring, UInt32, Ptr{Cvoid}, Int32),
szScriptFile, dwFlags, phRegData, fRemoveItems)
# szScriptFile : LPCWSTR -> Cwstring
# dwFlags : DWORD -> UInt32
# phRegData : HKEY* optional -> Ptr{Cvoid}
# fRemoveItems : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiAdvertiseScriptW(
const uint16_t* szScriptFile,
uint32_t dwFlags,
void* phRegData,
int32_t fRemoveItems);
]]
local msi = ffi.load("msi")
-- msi.MsiAdvertiseScriptW(szScriptFile, dwFlags, phRegData, fRemoveItems)
-- szScriptFile : LPCWSTR
-- dwFlags : DWORD
-- phRegData : HKEY* optional
-- 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 MsiAdvertiseScriptW = lib.func('__stdcall', 'MsiAdvertiseScriptW', 'uint32_t', ['str16', 'uint32_t', 'void *', 'int32_t']);
// MsiAdvertiseScriptW(szScriptFile, dwFlags, phRegData, fRemoveItems)
// szScriptFile : LPCWSTR -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// phRegData : HKEY* optional -> 'void *'
// fRemoveItems : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiAdvertiseScriptW: { parameters: ["buffer", "u32", "pointer", "i32"], result: "u32" },
});
// lib.symbols.MsiAdvertiseScriptW(szScriptFile, dwFlags, phRegData, fRemoveItems)
// szScriptFile : LPCWSTR -> "buffer"
// dwFlags : DWORD -> "u32"
// phRegData : HKEY* optional -> "pointer"
// fRemoveItems : BOOL -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiAdvertiseScriptW(
const uint16_t* szScriptFile,
uint32_t dwFlags,
void* phRegData,
int32_t fRemoveItems);
C, "msi.dll");
// $ffi->MsiAdvertiseScriptW(szScriptFile, dwFlags, phRegData, fRemoveItems);
// szScriptFile : LPCWSTR
// dwFlags : DWORD
// phRegData : HKEY* optional
// 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 MsiAdvertiseScriptW(
WString szScriptFile, // LPCWSTR
int dwFlags, // DWORD
Pointer phRegData, // HKEY* optional
boolean fRemoveItems // BOOL
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("msi")]
lib Libmsi
fun MsiAdvertiseScriptW = MsiAdvertiseScriptW(
szScriptFile : UInt16*, # LPCWSTR
dwFlags : UInt32, # DWORD
phRegData : Void*, # HKEY* optional
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 MsiAdvertiseScriptWNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Void>, Int32);
typedef MsiAdvertiseScriptWDart = int Function(Pointer<Utf16>, int, Pointer<Void>, int);
final MsiAdvertiseScriptW = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiAdvertiseScriptWNative, MsiAdvertiseScriptWDart>('MsiAdvertiseScriptW');
// szScriptFile : LPCWSTR -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// phRegData : HKEY* optional -> Pointer<Void>
// fRemoveItems : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiAdvertiseScriptW(
szScriptFile: PWideChar; // LPCWSTR
dwFlags: DWORD; // DWORD
phRegData: Pointer; // HKEY* optional
fRemoveItems: BOOL // BOOL
): DWORD; stdcall;
external 'msi.dll' name 'MsiAdvertiseScriptW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiAdvertiseScriptW"
c_MsiAdvertiseScriptW :: CWString -> Word32 -> Ptr () -> CInt -> IO Word32
-- szScriptFile : LPCWSTR -> CWString
-- dwFlags : DWORD -> Word32
-- phRegData : HKEY* optional -> Ptr ()
-- fRemoveItems : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msiadvertisescriptw =
foreign "MsiAdvertiseScriptW"
((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> int32_t @-> returning uint32_t)
(* szScriptFile : LPCWSTR -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* phRegData : HKEY* optional -> (ptr void) *)
(* 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 ("MsiAdvertiseScriptW" msi-advertise-script-w :convention :stdcall) :uint32
(sz-script-file (:string :encoding :utf-16le)) ; LPCWSTR
(dw-flags :uint32) ; DWORD
(ph-reg-data :pointer) ; HKEY* optional
(f-remove-items :int32)) ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiAdvertiseScriptW = Win32::API::More->new('msi',
'DWORD MsiAdvertiseScriptW(LPCWSTR szScriptFile, DWORD dwFlags, HANDLE phRegData, BOOL fRemoveItems)');
# my $ret = $MsiAdvertiseScriptW->Call($szScriptFile, $dwFlags, $phRegData, $fRemoveItems);
# szScriptFile : LPCWSTR -> LPCWSTR
# dwFlags : DWORD -> DWORD
# phRegData : HKEY* optional -> HANDLE
# fRemoveItems : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f MsiAdvertiseScriptA (ANSI版) — アドバタイズスクリプトを生成または適用する(ANSI版)。