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

MsiAdvertiseProductA

関数
製品をシステムにアドバタイズ(広告登録)する(ANSI版)。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiAdvertiseProductA(
    LPCSTR szPackagePath,
    LPCSTR szScriptfilePath,   // optional
    LPCSTR szTransforms,   // optional
    WORD lgidLanguage
);

パラメーター

名前方向説明
szPackagePathLPCSTRinアドバタイズする製品のパッケージへのフルパス。
szScriptfilePathLPCSTRinoptional

アドバタイズ情報とともに作成されるスクリプトファイルへのフルパス。製品をコンピューターにローカルにアドバタイズするには、ADVERTISEFLAGS_MACHINEASSIGN または ADVERTISEFLAGS_USERASSIGN を設定します。

フラグ 意味
ADVERTISEFLAGS_MACHINEASSIGN
0
すべてのユーザーが利用できる製品のマシン単位のインストールをアドバタイズするには設定します。
ADVERTISEFLAGS_USERASSIGN
1
特定のユーザーが利用できる製品のユーザー単位のインストールをアドバタイズするには設定します。
szTransformsLPCSTRinoptional適用するトランスフォームのセミコロン区切りのリスト。トランスフォームのリストには、トランスフォームのセキュアキャッシュを指定するために @ または | 文字をプレフィックスとして付加できます。@ プレフィックスは secure-at-source トランスフォームを指定し、| プレフィックスは secure full path トランスフォームを示します。詳細については、 Secured Transforms を参照してください。このパラメーターは null にできます。
lgidLanguageWORDinソースが複数の言語をサポートしている場合に使用するインストール言語。

戻り値の型: DWORD

公式ドキュメント

MsiAdvertiseProduct 関数は、アドバタイズスクリプトを生成するか、製品をコンピューターにアドバタイズします。(ANSI)

戻り値

意味
ERROR_SUCCESS
関数は正常に完了しました。
アクションに関連するエラー
Error Codes を参照してください。
Initialization Error
初期化エラーが発生しました。
ERROR_CALL_NOT_IMPLEMENTED
Windows 2000 または Windows XP 以外のプラットフォームでアドバタイズスクリプトを生成しようとした場合に、このエラーが返されます。ローカルコンピューターへのアドバタイズは、すべてのプラットフォームでサポートされています。

解説(Remarks)

メモ

msi.h ヘッダーは、MsiAdvertiseProduct を、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 MsiAdvertiseProductA(
    LPCSTR szPackagePath,
    LPCSTR szScriptfilePath,   // optional
    LPCSTR szTransforms,   // optional
    WORD lgidLanguage
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiAdvertiseProductA(
    [MarshalAs(UnmanagedType.LPStr)] string szPackagePath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szScriptfilePath,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string szTransforms,   // LPCSTR optional
    ushort lgidLanguage   // WORD
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiAdvertiseProductA(
    <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
) As UInteger
End Function
' szPackagePath : LPCSTR
' szScriptfilePath : LPCSTR optional
' szTransforms : LPCSTR optional
' lgidLanguage : WORD
Declare PtrSafe Function MsiAdvertiseProductA Lib "msi" ( _
    ByVal szPackagePath As String, _
    ByVal szScriptfilePath As String, _
    ByVal szTransforms As String, _
    ByVal lgidLanguage As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiAdvertiseProductA = ctypes.windll.msi.MsiAdvertiseProductA
MsiAdvertiseProductA.restype = wintypes.DWORD
MsiAdvertiseProductA.argtypes = [
    wintypes.LPCSTR,  # szPackagePath : LPCSTR
    wintypes.LPCSTR,  # szScriptfilePath : LPCSTR optional
    wintypes.LPCSTR,  # szTransforms : LPCSTR optional
    ctypes.c_ushort,  # lgidLanguage : WORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiAdvertiseProductA = Fiddle::Function.new(
  lib['MsiAdvertiseProductA'],
  [
    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)
#[link(name = "msi")]
extern "system" {
    fn MsiAdvertiseProductA(
        szPackagePath: *const u8,  // LPCSTR
        szScriptfilePath: *const u8,  // LPCSTR optional
        szTransforms: *const u8,  // LPCSTR optional
        lgidLanguage: u16  // WORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiAdvertiseProductA([MarshalAs(UnmanagedType.LPStr)] string szPackagePath, [MarshalAs(UnmanagedType.LPStr)] string szScriptfilePath, [MarshalAs(UnmanagedType.LPStr)] string szTransforms, ushort lgidLanguage);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiAdvertiseProductA' -Namespace Win32 -PassThru
# $api::MsiAdvertiseProductA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage)
#uselib "msi.dll"
#func global MsiAdvertiseProductA "MsiAdvertiseProductA" sptr, sptr, sptr, sptr
; MsiAdvertiseProductA szPackagePath, szScriptfilePath, szTransforms, lgidLanguage   ; 戻り値は stat
; szPackagePath : LPCSTR -> "sptr"
; szScriptfilePath : LPCSTR optional -> "sptr"
; szTransforms : LPCSTR optional -> "sptr"
; lgidLanguage : WORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiAdvertiseProductA "MsiAdvertiseProductA" str, str, str, int
; res = MsiAdvertiseProductA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage)
; szPackagePath : LPCSTR -> "str"
; szScriptfilePath : LPCSTR optional -> "str"
; szTransforms : LPCSTR optional -> "str"
; lgidLanguage : WORD -> "int"
; DWORD MsiAdvertiseProductA(LPCSTR szPackagePath, LPCSTR szScriptfilePath, LPCSTR szTransforms, WORD lgidLanguage)
#uselib "msi.dll"
#cfunc global MsiAdvertiseProductA "MsiAdvertiseProductA" str, str, str, int
; res = MsiAdvertiseProductA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage)
; szPackagePath : LPCSTR -> "str"
; szScriptfilePath : LPCSTR optional -> "str"
; szTransforms : LPCSTR optional -> "str"
; lgidLanguage : WORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiAdvertiseProductA = msi.NewProc("MsiAdvertiseProductA")
)

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

extern "msi" fn MsiAdvertiseProductA(
    szPackagePath: [*c]const u8, // LPCSTR
    szScriptfilePath: [*c]const u8, // LPCSTR optional
    szTransforms: [*c]const u8, // LPCSTR optional
    lgidLanguage: u16 // WORD
) callconv(std.os.windows.WINAPI) u32;
proc MsiAdvertiseProductA(
    szPackagePath: cstring,  # LPCSTR
    szScriptfilePath: cstring,  # LPCSTR optional
    szTransforms: cstring,  # LPCSTR optional
    lgidLanguage: uint16  # WORD
): uint32 {.importc: "MsiAdvertiseProductA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiAdvertiseProductA(
    const(char)* szPackagePath,   // LPCSTR
    const(char)* szScriptfilePath,   // LPCSTR optional
    const(char)* szTransforms,   // LPCSTR optional
    ushort lgidLanguage   // WORD
);
ccall((:MsiAdvertiseProductA, "msi.dll"), stdcall, UInt32,
      (Cstring, Cstring, Cstring, UInt16),
      szPackagePath, szScriptfilePath, szTransforms, lgidLanguage)
# szPackagePath : LPCSTR -> Cstring
# szScriptfilePath : LPCSTR optional -> Cstring
# szTransforms : LPCSTR optional -> Cstring
# lgidLanguage : WORD -> UInt16
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiAdvertiseProductA(
    const char* szPackagePath,
    const char* szScriptfilePath,
    const char* szTransforms,
    uint16_t lgidLanguage);
]]
local msi = ffi.load("msi")
-- msi.MsiAdvertiseProductA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage)
-- szPackagePath : LPCSTR
-- szScriptfilePath : LPCSTR optional
-- szTransforms : LPCSTR optional
-- lgidLanguage : WORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiAdvertiseProductA = lib.func('__stdcall', 'MsiAdvertiseProductA', 'uint32_t', ['str', 'str', 'str', 'uint16_t']);
// MsiAdvertiseProductA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage)
// szPackagePath : LPCSTR -> 'str'
// szScriptfilePath : LPCSTR optional -> 'str'
// szTransforms : LPCSTR optional -> 'str'
// lgidLanguage : WORD -> 'uint16_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiAdvertiseProductA: { parameters: ["buffer", "buffer", "buffer", "u16"], result: "u32" },
});
// lib.symbols.MsiAdvertiseProductA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage)
// szPackagePath : LPCSTR -> "buffer"
// szScriptfilePath : LPCSTR optional -> "buffer"
// szTransforms : LPCSTR optional -> "buffer"
// lgidLanguage : WORD -> "u16"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiAdvertiseProductA(
    const char* szPackagePath,
    const char* szScriptfilePath,
    const char* szTransforms,
    uint16_t lgidLanguage);
C, "msi.dll");
// $ffi->MsiAdvertiseProductA(szPackagePath, szScriptfilePath, szTransforms, lgidLanguage);
// szPackagePath : LPCSTR
// szScriptfilePath : LPCSTR optional
// szTransforms : LPCSTR optional
// lgidLanguage : WORD
// 構造体/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 MsiAdvertiseProductA(
        String szPackagePath,   // LPCSTR
        String szScriptfilePath,   // LPCSTR optional
        String szTransforms,   // LPCSTR optional
        short lgidLanguage   // WORD
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiAdvertiseProductA = MsiAdvertiseProductA(
    szPackagePath : UInt8*,   # LPCSTR
    szScriptfilePath : UInt8*,   # LPCSTR optional
    szTransforms : UInt8*,   # LPCSTR optional
    lgidLanguage : UInt16   # WORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiAdvertiseProductANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Uint16);
typedef MsiAdvertiseProductADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int);
final MsiAdvertiseProductA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiAdvertiseProductANative, MsiAdvertiseProductADart>('MsiAdvertiseProductA');
// szPackagePath : LPCSTR -> Pointer<Utf8>
// szScriptfilePath : LPCSTR optional -> Pointer<Utf8>
// szTransforms : LPCSTR optional -> Pointer<Utf8>
// lgidLanguage : WORD -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiAdvertiseProductA(
  szPackagePath: PAnsiChar;   // LPCSTR
  szScriptfilePath: PAnsiChar;   // LPCSTR optional
  szTransforms: PAnsiChar;   // LPCSTR optional
  lgidLanguage: Word   // WORD
): DWORD; stdcall;
  external 'msi.dll' name 'MsiAdvertiseProductA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiAdvertiseProductA"
  c_MsiAdvertiseProductA :: CString -> CString -> CString -> Word16 -> IO Word32
-- szPackagePath : LPCSTR -> CString
-- szScriptfilePath : LPCSTR optional -> CString
-- szTransforms : LPCSTR optional -> CString
-- lgidLanguage : WORD -> Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msiadvertiseproducta =
  foreign "MsiAdvertiseProductA"
    (string @-> string @-> string @-> uint16_t @-> returning uint32_t)
(* szPackagePath : LPCSTR -> string *)
(* szScriptfilePath : LPCSTR optional -> string *)
(* szTransforms : LPCSTR optional -> string *)
(* lgidLanguage : WORD -> uint16_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiAdvertiseProductA" msi-advertise-product-a :convention :stdcall) :uint32
  (sz-package-path :string)   ; LPCSTR
  (sz-scriptfile-path :string)   ; LPCSTR optional
  (sz-transforms :string)   ; LPCSTR optional
  (lgid-language :uint16))   ; WORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiAdvertiseProductA = Win32::API::More->new('msi',
    'DWORD MsiAdvertiseProductA(LPCSTR szPackagePath, LPCSTR szScriptfilePath, LPCSTR szTransforms, WORD lgidLanguage)');
# my $ret = $MsiAdvertiseProductA->Call($szPackagePath, $szScriptfilePath, $szTransforms, $lgidLanguage);
# szPackagePath : LPCSTR -> LPCSTR
# szScriptfilePath : LPCSTR optional -> LPCSTR
# szTransforms : LPCSTR optional -> LPCSTR
# lgidLanguage : WORD -> WORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API