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

MsiAdvertiseScriptA

関数
アドバタイズスクリプトを生成または適用する(ANSI版)。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiAdvertiseScriptA(
    LPCSTR szScriptFile,
    DWORD dwFlags,
    HKEY* phRegData,   // optional
    BOOL fRemoveItems
);

パラメーター

名前方向説明
szScriptFileLPCSTRinMsiAdvertiseProduct または MsiAdvertiseProductEx によって生成されたスクリプト ファイルへのフル パスです。
dwFlagsDWORDin

アドバタイズを制御する SCRIPTFLAGS の次のビット フラグです。dwFlags の値には、次の値の組み合わせを指定できます。

フラグ 意味
SCRIPTFLAGS_CACHEINFO
0x001
アイコンを作成または削除する必要がある場合は、このフラグを含めます。
SCRIPTFLAGS_SHORTCUTS
0x004
ショートカットを作成または削除する必要がある場合は、このフラグを含めます。
SCRIPTFLAGS_MACHINEASSIGN
0x008
製品をコンピューターに割り当てる場合は、このフラグを含めます。
SCRIPTFLAGS_REGDATA_CNFGINFO
0x020
レジストリ データ内の構成および管理情報を書き込みまたは削除する必要がある場合は、このフラグを含めます。
SCRIPTFLAGS_VALIDATE_TRANSFORMS_LIST
0x040
スクリプトに記載されたトランスフォームを、この製品に対して以前に登録されたトランスフォームと照合して検証を強制するには、このフラグを含めます。トランスフォームの競合は、大文字と小文字を区別しない文字列比較を使用して検出され、すべてのコンテキストにわたってユーザー単位とコンピューター単位のインストール間で評価されることに注意してください。スクリプト内のトランスフォームの一覧が製品に対して登録されたトランスフォームと一致しない場合、関数は ERROR_INSTALL_TRANSFORM_FAILURE を返します。
SCRIPTFLAGS_REGDATA_CLASSINFO
0x080
COM クラスに関連するアドバタイズ情報をレジストリに書き込みまたは削除する必要がある場合は、このフラグを含めます。
SCRIPTFLAGS_REGDATA_EXTENSIONINFO
0x100
拡張子に関連するアドバタイズ情報をレジストリに書き込みまたは削除する必要がある場合は、このフラグを含めます。
SCRIPTFLAGS_REGDATA_APPINFO
0x180
レジストリ内のアドバタイズ情報を書き込みまたは削除する必要がある場合は、このフラグを含めます。
SCRIPTFLAGS_REGDATA
0x1A0
レジストリ内のアドバタイズ情報を書き込みまたは削除する必要がある場合は、このフラグを含めます。
phRegDataHKEY*inoptional

レジストリ データに関する一時的な情報を書き込むレジストリ キーです。このパラメーターが null の場合、レジストリ データは、アドバタイズがユーザー単位かコンピューター単位かに基づいて適切なキーの下に配置されます。このパラメーターが null でない場合、スクリプトは通常の場所ではなく、指定されたレジストリ キーの下にレジストリ データを書き込みます。この場合、アプリケーションはユーザーに対してアドバタイズされません。

このレジストリ キーは、ユーザーまたはコンピューターに対する製品のアドバタイズを生成する際には使用できないことに注意してください。レジストリ キーの提供元が通常そのキーを削除するためです。このレジストリ キーは、シェル、クラス、および .msi 構成情報の通常のレジストリの場所の外に配置され、HKEY_CLASSES_ROOT の下にはありません。このレジストリ キーは、スクリプト内のレジストリ データに関する一時的な情報を取得することのみを目的としています。

fRemoveItemsBOOLin指定された項目を作成するのではなく削除する場合は TRUE。

戻り値の型: DWORD

公式ドキュメント

MsiAdvertiseScript 関数は、アドバタイズ スクリプト ファイルを指定された場所にコピーします。(ANSI)

戻り値

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

解説(Remarks)

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

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiAdvertiseScript を定義します。エンコード ニュートラルなエイリアスの使用を、エンコード ニュートラルでないコードと混在させると、コンパイル エラーまたは実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、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 MsiAdvertiseScriptA(
    LPCSTR szScriptFile,
    DWORD dwFlags,
    HKEY* phRegData,   // optional
    BOOL fRemoveItems
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiAdvertiseScriptA(
    [MarshalAs(UnmanagedType.LPStr)] string szScriptFile,   // LPCSTR
    uint dwFlags,   // DWORD
    IntPtr phRegData,   // HKEY* optional
    bool fRemoveItems   // BOOL
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiAdvertiseScriptA(
    <MarshalAs(UnmanagedType.LPStr)> szScriptFile As String,   ' LPCSTR
    dwFlags As UInteger,   ' DWORD
    phRegData As IntPtr,   ' HKEY* optional
    fRemoveItems As Boolean   ' BOOL
) As UInteger
End Function
' szScriptFile : LPCSTR
' dwFlags : DWORD
' phRegData : HKEY* optional
' fRemoveItems : BOOL
Declare PtrSafe Function MsiAdvertiseScriptA Lib "msi" ( _
    ByVal szScriptFile As String, _
    ByVal dwFlags As Long, _
    ByVal phRegData As LongPtr, _
    ByVal fRemoveItems As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiAdvertiseScriptA = ctypes.windll.msi.MsiAdvertiseScriptA
MsiAdvertiseScriptA.restype = wintypes.DWORD
MsiAdvertiseScriptA.argtypes = [
    wintypes.LPCSTR,  # szScriptFile : LPCSTR
    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')
MsiAdvertiseScriptA = Fiddle::Function.new(
  lib['MsiAdvertiseScriptA'],
  [
    Fiddle::TYPE_VOIDP,  # szScriptFile : LPCSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # phRegData : HKEY* optional
    Fiddle::TYPE_INT,  # fRemoveItems : BOOL
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiAdvertiseScriptA(
        szScriptFile: *const u8,  // LPCSTR
        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.Ansi)]
public static extern uint MsiAdvertiseScriptA([MarshalAs(UnmanagedType.LPStr)] string szScriptFile, uint dwFlags, IntPtr phRegData, bool fRemoveItems);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiAdvertiseScriptA' -Namespace Win32 -PassThru
# $api::MsiAdvertiseScriptA(szScriptFile, dwFlags, phRegData, fRemoveItems)
#uselib "msi.dll"
#func global MsiAdvertiseScriptA "MsiAdvertiseScriptA" sptr, sptr, sptr, sptr
; MsiAdvertiseScriptA szScriptFile, dwFlags, phRegData, fRemoveItems   ; 戻り値は stat
; szScriptFile : LPCSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; phRegData : HKEY* optional -> "sptr"
; fRemoveItems : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiAdvertiseScriptA "MsiAdvertiseScriptA" str, int, sptr, int
; res = MsiAdvertiseScriptA(szScriptFile, dwFlags, phRegData, fRemoveItems)
; szScriptFile : LPCSTR -> "str"
; dwFlags : DWORD -> "int"
; phRegData : HKEY* optional -> "sptr"
; fRemoveItems : BOOL -> "int"
; DWORD MsiAdvertiseScriptA(LPCSTR szScriptFile, DWORD dwFlags, HKEY* phRegData, BOOL fRemoveItems)
#uselib "msi.dll"
#cfunc global MsiAdvertiseScriptA "MsiAdvertiseScriptA" str, int, intptr, int
; res = MsiAdvertiseScriptA(szScriptFile, dwFlags, phRegData, fRemoveItems)
; szScriptFile : LPCSTR -> "str"
; dwFlags : DWORD -> "int"
; phRegData : HKEY* optional -> "intptr"
; fRemoveItems : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiAdvertiseScriptA = msi.NewProc("MsiAdvertiseScriptA")
)

// szScriptFile (LPCSTR), dwFlags (DWORD), phRegData (HKEY* optional), fRemoveItems (BOOL)
r1, _, err := procMsiAdvertiseScriptA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szScriptFile))),
	uintptr(dwFlags),
	uintptr(phRegData),
	uintptr(fRemoveItems),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiAdvertiseScriptA(
  szScriptFile: PAnsiChar;   // LPCSTR
  dwFlags: DWORD;   // DWORD
  phRegData: Pointer;   // HKEY* optional
  fRemoveItems: BOOL   // BOOL
): DWORD; stdcall;
  external 'msi.dll' name 'MsiAdvertiseScriptA';
result := DllCall("msi\MsiAdvertiseScriptA"
    , "AStr", szScriptFile   ; LPCSTR
    , "UInt", dwFlags   ; DWORD
    , "Ptr", phRegData   ; HKEY* optional
    , "Int", fRemoveItems   ; BOOL
    , "UInt")   ; return: DWORD
●MsiAdvertiseScriptA(szScriptFile, dwFlags, phRegData, fRemoveItems) = DLL("msi.dll", "dword MsiAdvertiseScriptA(char*, dword, void*, bool)")
# 呼び出し: MsiAdvertiseScriptA(szScriptFile, dwFlags, phRegData, fRemoveItems)
# szScriptFile : LPCSTR -> "char*"
# dwFlags : DWORD -> "dword"
# phRegData : HKEY* optional -> "void*"
# fRemoveItems : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "msi" fn MsiAdvertiseScriptA(
    szScriptFile: [*c]const u8, // LPCSTR
    dwFlags: u32, // DWORD
    phRegData: ?*anyopaque, // HKEY* optional
    fRemoveItems: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
proc MsiAdvertiseScriptA(
    szScriptFile: cstring,  # LPCSTR
    dwFlags: uint32,  # DWORD
    phRegData: pointer,  # HKEY* optional
    fRemoveItems: int32  # BOOL
): uint32 {.importc: "MsiAdvertiseScriptA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiAdvertiseScriptA(
    const(char)* szScriptFile,   // LPCSTR
    uint dwFlags,   // DWORD
    void* phRegData,   // HKEY* optional
    int fRemoveItems   // BOOL
);
ccall((:MsiAdvertiseScriptA, "msi.dll"), stdcall, UInt32,
      (Cstring, UInt32, Ptr{Cvoid}, Int32),
      szScriptFile, dwFlags, phRegData, fRemoveItems)
# szScriptFile : LPCSTR -> Cstring
# dwFlags : DWORD -> UInt32
# phRegData : HKEY* optional -> Ptr{Cvoid}
# fRemoveItems : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiAdvertiseScriptA(
    const char* szScriptFile,
    uint32_t dwFlags,
    void* phRegData,
    int32_t fRemoveItems);
]]
local msi = ffi.load("msi")
-- msi.MsiAdvertiseScriptA(szScriptFile, dwFlags, phRegData, fRemoveItems)
-- szScriptFile : LPCSTR
-- dwFlags : DWORD
-- phRegData : HKEY* optional
-- fRemoveItems : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiAdvertiseScriptA = lib.func('__stdcall', 'MsiAdvertiseScriptA', 'uint32_t', ['str', 'uint32_t', 'void *', 'int32_t']);
// MsiAdvertiseScriptA(szScriptFile, dwFlags, phRegData, fRemoveItems)
// szScriptFile : LPCSTR -> 'str'
// dwFlags : DWORD -> 'uint32_t'
// phRegData : HKEY* optional -> 'void *'
// fRemoveItems : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiAdvertiseScriptA: { parameters: ["buffer", "u32", "pointer", "i32"], result: "u32" },
});
// lib.symbols.MsiAdvertiseScriptA(szScriptFile, dwFlags, phRegData, fRemoveItems)
// szScriptFile : LPCSTR -> "buffer"
// dwFlags : DWORD -> "u32"
// phRegData : HKEY* optional -> "pointer"
// fRemoveItems : BOOL -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiAdvertiseScriptA(
    const char* szScriptFile,
    uint32_t dwFlags,
    void* phRegData,
    int32_t fRemoveItems);
C, "msi.dll");
// $ffi->MsiAdvertiseScriptA(szScriptFile, dwFlags, phRegData, fRemoveItems);
// szScriptFile : LPCSTR
// 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.ASCII_OPTIONS);
    int MsiAdvertiseScriptA(
        String szScriptFile,   // LPCSTR
        int dwFlags,   // DWORD
        Pointer phRegData,   // HKEY* optional
        boolean fRemoveItems   // BOOL
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiAdvertiseScriptA = MsiAdvertiseScriptA(
    szScriptFile : UInt8*,   # LPCSTR
    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 MsiAdvertiseScriptANative = Uint32 Function(Pointer<Utf8>, Uint32, Pointer<Void>, Int32);
typedef MsiAdvertiseScriptADart = int Function(Pointer<Utf8>, int, Pointer<Void>, int);
final MsiAdvertiseScriptA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiAdvertiseScriptANative, MsiAdvertiseScriptADart>('MsiAdvertiseScriptA');
// szScriptFile : LPCSTR -> Pointer<Utf8>
// dwFlags : DWORD -> Uint32
// phRegData : HKEY* optional -> Pointer<Void>
// fRemoveItems : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiAdvertiseScriptA(
  szScriptFile: PAnsiChar;   // LPCSTR
  dwFlags: DWORD;   // DWORD
  phRegData: Pointer;   // HKEY* optional
  fRemoveItems: BOOL   // BOOL
): DWORD; stdcall;
  external 'msi.dll' name 'MsiAdvertiseScriptA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiAdvertiseScriptA"
  c_MsiAdvertiseScriptA :: CString -> Word32 -> Ptr () -> CInt -> IO Word32
-- szScriptFile : LPCSTR -> CString
-- dwFlags : DWORD -> Word32
-- phRegData : HKEY* optional -> Ptr ()
-- fRemoveItems : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

関連項目

文字セット違い