MsiAdvertiseProductExA
関数シグネチャ
// msi.dll (ANSI / -A)
#include <windows.h>
DWORD MsiAdvertiseProductExA(
LPCSTR szPackagePath,
LPCSTR szScriptfilePath, // optional
LPCSTR szTransforms, // optional
WORD lgidLanguage,
DWORD dwPlatform,
DWORD dwOptions
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| szPackagePath | LPCSTR | in | アドバタイズする製品のパッケージへの完全なパスです。 | ||||||||||
| szScriptfilePath | LPCSTR | inoptional | アドバタイズ情報を書き込んで作成するスクリプトファイルへの完全なパスです。製品をコンピューターにローカルにアドバタイズするには、ADVERTISEFLAGS_MACHINEASSIGN または ADVERTISEFLAGS_USERASSIGN を設定します。
| ||||||||||
| szTransforms | LPCSTR | inoptional | 適用するトランスフォームのセミコロン区切りのリストです。トランスフォームのリストには、トランスフォームのセキュアキャッシュを指定するために @ または | 文字をプレフィックスとして付けることができます。@ プレフィックスはソースでセキュアなトランスフォームを指定し、| プレフィックスは完全パスでセキュアなトランスフォームを示します。詳細については、 Secured Transforms を参照してください。このパラメーターは null にできます。 | ||||||||||
| lgidLanguage | WORD | in | ソースが複数の言語をサポートしている場合に使用する言語です。 | ||||||||||
| dwPlatform | DWORD | in | インストーラーがスクリプトを作成する対象プラットフォームを制御するビットフラグです。szScriptfilePath が null の場合、このパラメーターは無視されます。dwPlatform がゼロ (0) の場合、スクリプトは現在のプラットフォームに基づいて作成されます。これは MsiAdvertiseProduct と同じ機能です。dwPlatform が 1 または 2 の場合、インストーラーは指定されたプラットフォーム用のスクリプトを作成します。
| ||||||||||
| dwOptions | DWORD | in | 追加のアドバタイズオプションを指定するビットフラグです。ゼロ以外の値は、Windows Server 2003 および Windows XP with SP1 以降に付属する Windows Installer のバージョンでのみ使用できます。
|
戻り値の型: DWORD
公式ドキュメント
MsiAdvertiseProductEx 関数は、アドバタイズスクリプトを生成するか、製品をコンピューターにアドバタイズします。(ANSI)
戻り値
| Value | Meaning |
|---|---|
| 関数が正常に完了しました。 | |
|
詳細については、 Error Codes を参照してください。 |
| 初期化エラーが発生しました。 | |
| Windows 2000 または Windows XP 以外のプラットフォームでアドバタイズスクリプトを生成しようとした場合に、このエラーが返されます。ローカルコンピューターへのアドバタイズは、すべてのプラットフォームでサポートされています。 |
解説(Remarks)
プロダクトコードを変更するトランスフォームによる複数インスタンスは、Windows Server 2003 および Windows XP with SP1 以降に付属する Windows Installer のバージョンでのみ使用できます。
msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiAdvertiseProductEx を定義します。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーが発生する可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (ANSI / -A)
#include <windows.h>
DWORD MsiAdvertiseProductExA(
LPCSTR szPackagePath,
LPCSTR szScriptfilePath, // optional
LPCSTR szTransforms, // optional
WORD lgidLanguage,
DWORD dwPlatform,
DWORD dwOptions
);[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiAdvertiseProductExA(
[MarshalAs(UnmanagedType.LPStr)] string szPackagePath, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string szScriptfilePath, // LPCSTR optional
[MarshalAs(UnmanagedType.LPStr)] string szTransforms, // LPCSTR optional
ushort lgidLanguage, // WORD
uint dwPlatform, // DWORD
uint dwOptions // DWORD
);<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiAdvertiseProductExA(
<MarshalAs(UnmanagedType.LPStr)> szPackagePath As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> szScriptfilePath As String, ' LPCSTR optional
<MarshalAs(UnmanagedType.LPStr)> szTransforms As String, ' LPCSTR optional
lgidLanguage As UShort, ' WORD
dwPlatform As UInteger, ' DWORD
dwOptions As UInteger ' DWORD
) As UInteger
End Function' szPackagePath : LPCSTR
' szScriptfilePath : LPCSTR optional
' szTransforms : LPCSTR optional
' lgidLanguage : WORD
' dwPlatform : DWORD
' dwOptions : DWORD
Declare PtrSafe Function MsiAdvertiseProductExA Lib "msi" ( _
ByVal szPackagePath As String, _
ByVal szScriptfilePath As String, _
ByVal szTransforms As String, _
ByVal lgidLanguage As Integer, _
ByVal dwPlatform As Long, _
ByVal dwOptions As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
MsiAdvertiseProductExA = ctypes.windll.msi.MsiAdvertiseProductExA
MsiAdvertiseProductExA.restype = wintypes.DWORD
MsiAdvertiseProductExA.argtypes = [
wintypes.LPCSTR, # szPackagePath : LPCSTR
wintypes.LPCSTR, # szScriptfilePath : LPCSTR optional
wintypes.LPCSTR, # szTransforms : LPCSTR optional
ctypes.c_ushort, # lgidLanguage : WORD
wintypes.DWORD, # dwPlatform : DWORD
wintypes.DWORD, # dwOptions : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiAdvertiseProductExA = Fiddle::Function.new(
lib['MsiAdvertiseProductExA'],
[
Fiddle::TYPE_VOIDP, # szPackagePath : LPCSTR
Fiddle::TYPE_VOIDP, # szScriptfilePath : LPCSTR optional
Fiddle::TYPE_VOIDP, # szTransforms : LPCSTR optional
-Fiddle::TYPE_SHORT, # lgidLanguage : WORD
-Fiddle::TYPE_INT, # dwPlatform : DWORD
-Fiddle::TYPE_INT, # dwOptions : DWORD
],
-Fiddle::TYPE_INT)#[link(name = "msi")]
extern "system" {
fn MsiAdvertiseProductExA(
szPackagePath: *const u8, // LPCSTR
szScriptfilePath: *const u8, // LPCSTR optional
szTransforms: *const u8, // LPCSTR optional
lgidLanguage: u16, // WORD
dwPlatform: u32, // DWORD
dwOptions: u32 // DWORD
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiAdvertiseProductExA([MarshalAs(UnmanagedType.LPStr)] string szPackagePath, [MarshalAs(UnmanagedType.LPStr)] string szScriptfilePath, [MarshalAs(UnmanagedType.LPStr)] string szTransforms, ushort lgidLanguage, uint dwPlatform, uint dwOptions);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiAdvertiseProductExA' -Namespace Win32 -PassThru
# $api::MsiAdvertiseProductExA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage, dwPlatform, dwOptions)#uselib "msi.dll"
#func global MsiAdvertiseProductExA "MsiAdvertiseProductExA" sptr, sptr, sptr, sptr, sptr, sptr
; MsiAdvertiseProductExA szPackagePath, szScriptfilePath, szTransforms, lgidLanguage, dwPlatform, dwOptions ; 戻り値は stat
; szPackagePath : LPCSTR -> "sptr"
; szScriptfilePath : LPCSTR optional -> "sptr"
; szTransforms : LPCSTR optional -> "sptr"
; lgidLanguage : WORD -> "sptr"
; dwPlatform : DWORD -> "sptr"
; dwOptions : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "msi.dll"
#cfunc global MsiAdvertiseProductExA "MsiAdvertiseProductExA" str, str, str, int, int, int
; res = MsiAdvertiseProductExA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage, dwPlatform, dwOptions)
; szPackagePath : LPCSTR -> "str"
; szScriptfilePath : LPCSTR optional -> "str"
; szTransforms : LPCSTR optional -> "str"
; lgidLanguage : WORD -> "int"
; dwPlatform : DWORD -> "int"
; dwOptions : DWORD -> "int"; DWORD MsiAdvertiseProductExA(LPCSTR szPackagePath, LPCSTR szScriptfilePath, LPCSTR szTransforms, WORD lgidLanguage, DWORD dwPlatform, DWORD dwOptions)
#uselib "msi.dll"
#cfunc global MsiAdvertiseProductExA "MsiAdvertiseProductExA" str, str, str, int, int, int
; res = MsiAdvertiseProductExA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage, dwPlatform, dwOptions)
; szPackagePath : LPCSTR -> "str"
; szScriptfilePath : LPCSTR optional -> "str"
; szTransforms : LPCSTR optional -> "str"
; lgidLanguage : WORD -> "int"
; dwPlatform : DWORD -> "int"
; dwOptions : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiAdvertiseProductExA = msi.NewProc("MsiAdvertiseProductExA")
)
// szPackagePath (LPCSTR), szScriptfilePath (LPCSTR optional), szTransforms (LPCSTR optional), lgidLanguage (WORD), dwPlatform (DWORD), dwOptions (DWORD)
r1, _, err := procMsiAdvertiseProductExA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(szPackagePath))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(szScriptfilePath))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(szTransforms))),
uintptr(lgidLanguage),
uintptr(dwPlatform),
uintptr(dwOptions),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiAdvertiseProductExA(
szPackagePath: PAnsiChar; // LPCSTR
szScriptfilePath: PAnsiChar; // LPCSTR optional
szTransforms: PAnsiChar; // LPCSTR optional
lgidLanguage: Word; // WORD
dwPlatform: DWORD; // DWORD
dwOptions: DWORD // DWORD
): DWORD; stdcall;
external 'msi.dll' name 'MsiAdvertiseProductExA';result := DllCall("msi\MsiAdvertiseProductExA"
, "AStr", szPackagePath ; LPCSTR
, "AStr", szScriptfilePath ; LPCSTR optional
, "AStr", szTransforms ; LPCSTR optional
, "UShort", lgidLanguage ; WORD
, "UInt", dwPlatform ; DWORD
, "UInt", dwOptions ; DWORD
, "UInt") ; return: DWORD●MsiAdvertiseProductExA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage, dwPlatform, dwOptions) = DLL("msi.dll", "dword MsiAdvertiseProductExA(char*, char*, char*, int, dword, dword)")
# 呼び出し: MsiAdvertiseProductExA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage, dwPlatform, dwOptions)
# szPackagePath : LPCSTR -> "char*"
# szScriptfilePath : LPCSTR optional -> "char*"
# szTransforms : LPCSTR optional -> "char*"
# lgidLanguage : WORD -> "int"
# dwPlatform : DWORD -> "dword"
# dwOptions : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "msi" fn MsiAdvertiseProductExA(
szPackagePath: [*c]const u8, // LPCSTR
szScriptfilePath: [*c]const u8, // LPCSTR optional
szTransforms: [*c]const u8, // LPCSTR optional
lgidLanguage: u16, // WORD
dwPlatform: u32, // DWORD
dwOptions: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;proc MsiAdvertiseProductExA(
szPackagePath: cstring, # LPCSTR
szScriptfilePath: cstring, # LPCSTR optional
szTransforms: cstring, # LPCSTR optional
lgidLanguage: uint16, # WORD
dwPlatform: uint32, # DWORD
dwOptions: uint32 # DWORD
): uint32 {.importc: "MsiAdvertiseProductExA", stdcall, dynlib: "msi.dll".}pragma(lib, "msi");
extern(Windows)
uint MsiAdvertiseProductExA(
const(char)* szPackagePath, // LPCSTR
const(char)* szScriptfilePath, // LPCSTR optional
const(char)* szTransforms, // LPCSTR optional
ushort lgidLanguage, // WORD
uint dwPlatform, // DWORD
uint dwOptions // DWORD
);ccall((:MsiAdvertiseProductExA, "msi.dll"), stdcall, UInt32,
(Cstring, Cstring, Cstring, UInt16, UInt32, UInt32),
szPackagePath, szScriptfilePath, szTransforms, lgidLanguage, dwPlatform, dwOptions)
# szPackagePath : LPCSTR -> Cstring
# szScriptfilePath : LPCSTR optional -> Cstring
# szTransforms : LPCSTR optional -> Cstring
# lgidLanguage : WORD -> UInt16
# dwPlatform : DWORD -> UInt32
# dwOptions : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiAdvertiseProductExA(
const char* szPackagePath,
const char* szScriptfilePath,
const char* szTransforms,
uint16_t lgidLanguage,
uint32_t dwPlatform,
uint32_t dwOptions);
]]
local msi = ffi.load("msi")
-- msi.MsiAdvertiseProductExA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage, dwPlatform, dwOptions)
-- szPackagePath : LPCSTR
-- szScriptfilePath : LPCSTR optional
-- szTransforms : LPCSTR optional
-- lgidLanguage : WORD
-- dwPlatform : DWORD
-- dwOptions : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiAdvertiseProductExA = lib.func('__stdcall', 'MsiAdvertiseProductExA', 'uint32_t', ['str', 'str', 'str', 'uint16_t', 'uint32_t', 'uint32_t']);
// MsiAdvertiseProductExA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage, dwPlatform, dwOptions)
// szPackagePath : LPCSTR -> 'str'
// szScriptfilePath : LPCSTR optional -> 'str'
// szTransforms : LPCSTR optional -> 'str'
// lgidLanguage : WORD -> 'uint16_t'
// dwPlatform : DWORD -> 'uint32_t'
// dwOptions : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiAdvertiseProductExA: { parameters: ["buffer", "buffer", "buffer", "u16", "u32", "u32"], result: "u32" },
});
// lib.symbols.MsiAdvertiseProductExA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage, dwPlatform, dwOptions)
// szPackagePath : LPCSTR -> "buffer"
// szScriptfilePath : LPCSTR optional -> "buffer"
// szTransforms : LPCSTR optional -> "buffer"
// lgidLanguage : WORD -> "u16"
// dwPlatform : DWORD -> "u32"
// dwOptions : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiAdvertiseProductExA(
const char* szPackagePath,
const char* szScriptfilePath,
const char* szTransforms,
uint16_t lgidLanguage,
uint32_t dwPlatform,
uint32_t dwOptions);
C, "msi.dll");
// $ffi->MsiAdvertiseProductExA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage, dwPlatform, dwOptions);
// szPackagePath : LPCSTR
// szScriptfilePath : LPCSTR optional
// szTransforms : LPCSTR optional
// lgidLanguage : WORD
// dwPlatform : DWORD
// dwOptions : DWORD
// 構造体/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 MsiAdvertiseProductExA(
String szPackagePath, // LPCSTR
String szScriptfilePath, // LPCSTR optional
String szTransforms, // LPCSTR optional
short lgidLanguage, // WORD
int dwPlatform, // DWORD
int dwOptions // DWORD
);
}@[Link("msi")]
lib Libmsi
fun MsiAdvertiseProductExA = MsiAdvertiseProductExA(
szPackagePath : UInt8*, # LPCSTR
szScriptfilePath : UInt8*, # LPCSTR optional
szTransforms : UInt8*, # LPCSTR optional
lgidLanguage : UInt16, # WORD
dwPlatform : UInt32, # DWORD
dwOptions : UInt32 # DWORD
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MsiAdvertiseProductExANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Uint16, Uint32, Uint32);
typedef MsiAdvertiseProductExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int, int, int);
final MsiAdvertiseProductExA = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiAdvertiseProductExANative, MsiAdvertiseProductExADart>('MsiAdvertiseProductExA');
// szPackagePath : LPCSTR -> Pointer<Utf8>
// szScriptfilePath : LPCSTR optional -> Pointer<Utf8>
// szTransforms : LPCSTR optional -> Pointer<Utf8>
// lgidLanguage : WORD -> Uint16
// dwPlatform : DWORD -> Uint32
// dwOptions : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiAdvertiseProductExA(
szPackagePath: PAnsiChar; // LPCSTR
szScriptfilePath: PAnsiChar; // LPCSTR optional
szTransforms: PAnsiChar; // LPCSTR optional
lgidLanguage: Word; // WORD
dwPlatform: DWORD; // DWORD
dwOptions: DWORD // DWORD
): DWORD; stdcall;
external 'msi.dll' name 'MsiAdvertiseProductExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiAdvertiseProductExA"
c_MsiAdvertiseProductExA :: CString -> CString -> CString -> Word16 -> Word32 -> Word32 -> IO Word32
-- szPackagePath : LPCSTR -> CString
-- szScriptfilePath : LPCSTR optional -> CString
-- szTransforms : LPCSTR optional -> CString
-- lgidLanguage : WORD -> Word16
-- dwPlatform : DWORD -> Word32
-- dwOptions : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msiadvertiseproductexa =
foreign "MsiAdvertiseProductExA"
(string @-> string @-> string @-> uint16_t @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* szPackagePath : LPCSTR -> string *)
(* szScriptfilePath : LPCSTR optional -> string *)
(* szTransforms : LPCSTR optional -> string *)
(* lgidLanguage : WORD -> uint16_t *)
(* dwPlatform : DWORD -> uint32_t *)
(* dwOptions : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)
(cffi:defcfun ("MsiAdvertiseProductExA" msi-advertise-product-ex-a :convention :stdcall) :uint32
(sz-package-path :string) ; LPCSTR
(sz-scriptfile-path :string) ; LPCSTR optional
(sz-transforms :string) ; LPCSTR optional
(lgid-language :uint16) ; WORD
(dw-platform :uint32) ; DWORD
(dw-options :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiAdvertiseProductExA = Win32::API::More->new('msi',
'DWORD MsiAdvertiseProductExA(LPCSTR szPackagePath, LPCSTR szScriptfilePath, LPCSTR szTransforms, WORD lgidLanguage, DWORD dwPlatform, DWORD dwOptions)');
# my $ret = $MsiAdvertiseProductExA->Call($szPackagePath, $szScriptfilePath, $szTransforms, $lgidLanguage, $dwPlatform, $dwOptions);
# szPackagePath : LPCSTR -> LPCSTR
# szScriptfilePath : LPCSTR optional -> LPCSTR
# szTransforms : LPCSTR optional -> LPCSTR
# lgidLanguage : WORD -> WORD
# dwPlatform : DWORD -> DWORD
# dwOptions : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f MsiAdvertiseProductExW (Unicode版) — オプション指定で製品をアドバタイズする(Unicode版)。
- f MsiAdvertiseProductA — 製品をシステムにアドバタイズ(広告登録)する(ANSI版)。