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

MsiPreviewBillboardW

関数
コントロール上にビルボードをプレビュー表示する(Unicode版)。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiPreviewBillboardW(
    MSIHANDLE hPreview,
    LPCWSTR szControlName,
    LPCWSTR szBillboard
);

パラメーター

名前方向説明
hPreviewMSIHANDLEinプレビューへのハンドルです。
szControlNameLPCWSTRinホストコントロールの名前を指定します。
szBillboardLPCWSTRin表示するビルボードの名前を指定します。

戻り値の型: DWORD

公式ドキュメント

MsiPreviewBillboard 関数は、表示されているダイアログボックス内に、ホストコントロールとともにビルボードを表示します。(Unicode)

戻り値

この関数は UINT を返します。

解説(Remarks)

MsiPreviewBillboard 関数にビルボード名として null を指定すると、表示されているビルボードがすべて削除されます。

メモ

msiquery.h ヘッダーは MsiPreviewBillboard をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiPreviewBillboardW(
    MSIHANDLE hPreview,
    LPCWSTR szControlName,
    LPCWSTR szBillboard
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiPreviewBillboardW(
    uint hPreview,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szControlName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string szBillboard   // LPCWSTR
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiPreviewBillboardW(
    hPreview As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szControlName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> szBillboard As String   ' LPCWSTR
) As UInteger
End Function
' hPreview : MSIHANDLE
' szControlName : LPCWSTR
' szBillboard : LPCWSTR
Declare PtrSafe Function MsiPreviewBillboardW Lib "msi" ( _
    ByVal hPreview As Long, _
    ByVal szControlName As LongPtr, _
    ByVal szBillboard As LongPtr) 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

MsiPreviewBillboardW = ctypes.windll.msi.MsiPreviewBillboardW
MsiPreviewBillboardW.restype = wintypes.DWORD
MsiPreviewBillboardW.argtypes = [
    wintypes.DWORD,  # hPreview : MSIHANDLE
    wintypes.LPCWSTR,  # szControlName : LPCWSTR
    wintypes.LPCWSTR,  # szBillboard : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiPreviewBillboardW = Fiddle::Function.new(
  lib['MsiPreviewBillboardW'],
  [
    -Fiddle::TYPE_INT,  # hPreview : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szControlName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # szBillboard : LPCWSTR
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msi")]
extern "system" {
    fn MsiPreviewBillboardW(
        hPreview: u32,  // MSIHANDLE
        szControlName: *const u16,  // LPCWSTR
        szBillboard: *const u16  // LPCWSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiPreviewBillboardW(uint hPreview, [MarshalAs(UnmanagedType.LPWStr)] string szControlName, [MarshalAs(UnmanagedType.LPWStr)] string szBillboard);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiPreviewBillboardW' -Namespace Win32 -PassThru
# $api::MsiPreviewBillboardW(hPreview, szControlName, szBillboard)
#uselib "msi.dll"
#func global MsiPreviewBillboardW "MsiPreviewBillboardW" wptr, wptr, wptr
; MsiPreviewBillboardW hPreview, szControlName, szBillboard   ; 戻り値は stat
; hPreview : MSIHANDLE -> "wptr"
; szControlName : LPCWSTR -> "wptr"
; szBillboard : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiPreviewBillboardW "MsiPreviewBillboardW" int, wstr, wstr
; res = MsiPreviewBillboardW(hPreview, szControlName, szBillboard)
; hPreview : MSIHANDLE -> "int"
; szControlName : LPCWSTR -> "wstr"
; szBillboard : LPCWSTR -> "wstr"
; DWORD MsiPreviewBillboardW(MSIHANDLE hPreview, LPCWSTR szControlName, LPCWSTR szBillboard)
#uselib "msi.dll"
#cfunc global MsiPreviewBillboardW "MsiPreviewBillboardW" int, wstr, wstr
; res = MsiPreviewBillboardW(hPreview, szControlName, szBillboard)
; hPreview : MSIHANDLE -> "int"
; szControlName : LPCWSTR -> "wstr"
; szBillboard : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiPreviewBillboardW = msi.NewProc("MsiPreviewBillboardW")
)

// hPreview (MSIHANDLE), szControlName (LPCWSTR), szBillboard (LPCWSTR)
r1, _, err := procMsiPreviewBillboardW.Call(
	uintptr(hPreview),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szControlName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szBillboard))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiPreviewBillboardW(
  hPreview: DWORD;   // MSIHANDLE
  szControlName: PWideChar;   // LPCWSTR
  szBillboard: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'msi.dll' name 'MsiPreviewBillboardW';
result := DllCall("msi\MsiPreviewBillboardW"
    , "UInt", hPreview   ; MSIHANDLE
    , "WStr", szControlName   ; LPCWSTR
    , "WStr", szBillboard   ; LPCWSTR
    , "UInt")   ; return: DWORD
●MsiPreviewBillboardW(hPreview, szControlName, szBillboard) = DLL("msi.dll", "dword MsiPreviewBillboardW(dword, char*, char*)")
# 呼び出し: MsiPreviewBillboardW(hPreview, szControlName, szBillboard)
# hPreview : MSIHANDLE -> "dword"
# szControlName : LPCWSTR -> "char*"
# szBillboard : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "msi" fn MsiPreviewBillboardW(
    hPreview: u32, // MSIHANDLE
    szControlName: [*c]const u16, // LPCWSTR
    szBillboard: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiPreviewBillboardW(
    hPreview: uint32,  # MSIHANDLE
    szControlName: WideCString,  # LPCWSTR
    szBillboard: WideCString  # LPCWSTR
): uint32 {.importc: "MsiPreviewBillboardW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
uint MsiPreviewBillboardW(
    uint hPreview,   // MSIHANDLE
    const(wchar)* szControlName,   // LPCWSTR
    const(wchar)* szBillboard   // LPCWSTR
);
ccall((:MsiPreviewBillboardW, "msi.dll"), stdcall, UInt32,
      (UInt32, Cwstring, Cwstring),
      hPreview, szControlName, szBillboard)
# hPreview : MSIHANDLE -> UInt32
# szControlName : LPCWSTR -> Cwstring
# szBillboard : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiPreviewBillboardW(
    uint32_t hPreview,
    const uint16_t* szControlName,
    const uint16_t* szBillboard);
]]
local msi = ffi.load("msi")
-- msi.MsiPreviewBillboardW(hPreview, szControlName, szBillboard)
-- hPreview : MSIHANDLE
-- szControlName : LPCWSTR
-- szBillboard : LPCWSTR
-- 構造体/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 MsiPreviewBillboardW = lib.func('__stdcall', 'MsiPreviewBillboardW', 'uint32_t', ['uint32_t', 'str16', 'str16']);
// MsiPreviewBillboardW(hPreview, szControlName, szBillboard)
// hPreview : MSIHANDLE -> 'uint32_t'
// szControlName : LPCWSTR -> 'str16'
// szBillboard : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiPreviewBillboardW: { parameters: ["u32", "buffer", "buffer"], result: "u32" },
});
// lib.symbols.MsiPreviewBillboardW(hPreview, szControlName, szBillboard)
// hPreview : MSIHANDLE -> "u32"
// szControlName : LPCWSTR -> "buffer"
// szBillboard : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiPreviewBillboardW(
    uint32_t hPreview,
    const uint16_t* szControlName,
    const uint16_t* szBillboard);
C, "msi.dll");
// $ffi->MsiPreviewBillboardW(hPreview, szControlName, szBillboard);
// hPreview : MSIHANDLE
// szControlName : LPCWSTR
// szBillboard : LPCWSTR
// 構造体/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 MsiPreviewBillboardW(
        int hPreview,   // MSIHANDLE
        WString szControlName,   // LPCWSTR
        WString szBillboard   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiPreviewBillboardW = MsiPreviewBillboardW(
    hPreview : UInt32,   # MSIHANDLE
    szControlName : UInt16*,   # LPCWSTR
    szBillboard : UInt16*   # LPCWSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiPreviewBillboardWNative = Uint32 Function(Uint32, Pointer<Utf16>, Pointer<Utf16>);
typedef MsiPreviewBillboardWDart = int Function(int, Pointer<Utf16>, Pointer<Utf16>);
final MsiPreviewBillboardW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiPreviewBillboardWNative, MsiPreviewBillboardWDart>('MsiPreviewBillboardW');
// hPreview : MSIHANDLE -> Uint32
// szControlName : LPCWSTR -> Pointer<Utf16>
// szBillboard : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiPreviewBillboardW(
  hPreview: DWORD;   // MSIHANDLE
  szControlName: PWideChar;   // LPCWSTR
  szBillboard: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'msi.dll' name 'MsiPreviewBillboardW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiPreviewBillboardW"
  c_MsiPreviewBillboardW :: Word32 -> CWString -> CWString -> IO Word32
-- hPreview : MSIHANDLE -> Word32
-- szControlName : LPCWSTR -> CWString
-- szBillboard : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msipreviewbillboardw =
  foreign "MsiPreviewBillboardW"
    (uint32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* hPreview : MSIHANDLE -> uint32_t *)
(* szControlName : LPCWSTR -> (ptr uint16_t) *)
(* szBillboard : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiPreviewBillboardW" msi-preview-billboard-w :convention :stdcall) :uint32
  (h-preview :uint32)   ; MSIHANDLE
  (sz-control-name (:string :encoding :utf-16le))   ; LPCWSTR
  (sz-billboard (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiPreviewBillboardW = Win32::API::More->new('msi',
    'DWORD MsiPreviewBillboardW(DWORD hPreview, LPCWSTR szControlName, LPCWSTR szBillboard)');
# my $ret = $MsiPreviewBillboardW->Call($hPreview, $szControlName, $szBillboard);
# hPreview : MSIHANDLE -> DWORD
# szControlName : LPCWSTR -> LPCWSTR
# szBillboard : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い