ホーム › System.ApplicationInstallationAndServicing › MsiPreviewBillboardA
MsiPreviewBillboardA
関数コントロール上にビルボードをプレビュー表示する(ANSI版)。
シグネチャ
// msi.dll (ANSI / -A)
#include <windows.h>
DWORD MsiPreviewBillboardA(
MSIHANDLE hPreview,
LPCSTR szControlName,
LPCSTR szBillboard
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hPreview | MSIHANDLE | in | プレビューへのハンドル。 |
| szControlName | LPCSTR | in | ホストコントロールの名前を指定します。 |
| szBillboard | LPCSTR | in | 表示するビルボードの名前を指定します。 |
戻り値の型: DWORD
公式ドキュメント
MsiPreviewBillboard 関数は、表示中のダイアログボックスにホストコントロールを伴うビルボードを表示します。(ANSI)
戻り値
この関数は UINT を返します。
解説(Remarks)
MsiPreviewBillboard 関数で null のビルボード名を指定すると、表示されているビルボードが削除されます。
メモ
msiquery.h ヘッダーは MsiPreviewBillboard を、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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (ANSI / -A)
#include <windows.h>
DWORD MsiPreviewBillboardA(
MSIHANDLE hPreview,
LPCSTR szControlName,
LPCSTR szBillboard
);[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiPreviewBillboardA(
uint hPreview, // MSIHANDLE
[MarshalAs(UnmanagedType.LPStr)] string szControlName, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string szBillboard // LPCSTR
);<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiPreviewBillboardA(
hPreview As UInteger, ' MSIHANDLE
<MarshalAs(UnmanagedType.LPStr)> szControlName As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> szBillboard As String ' LPCSTR
) As UInteger
End Function' hPreview : MSIHANDLE
' szControlName : LPCSTR
' szBillboard : LPCSTR
Declare PtrSafe Function MsiPreviewBillboardA Lib "msi" ( _
ByVal hPreview As Long, _
ByVal szControlName As String, _
ByVal szBillboard As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
MsiPreviewBillboardA = ctypes.windll.msi.MsiPreviewBillboardA
MsiPreviewBillboardA.restype = wintypes.DWORD
MsiPreviewBillboardA.argtypes = [
wintypes.DWORD, # hPreview : MSIHANDLE
wintypes.LPCSTR, # szControlName : LPCSTR
wintypes.LPCSTR, # szBillboard : LPCSTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiPreviewBillboardA = Fiddle::Function.new(
lib['MsiPreviewBillboardA'],
[
-Fiddle::TYPE_INT, # hPreview : MSIHANDLE
Fiddle::TYPE_VOIDP, # szControlName : LPCSTR
Fiddle::TYPE_VOIDP, # szBillboard : LPCSTR
],
-Fiddle::TYPE_INT)#[link(name = "msi")]
extern "system" {
fn MsiPreviewBillboardA(
hPreview: u32, // MSIHANDLE
szControlName: *const u8, // LPCSTR
szBillboard: *const u8 // LPCSTR
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiPreviewBillboardA(uint hPreview, [MarshalAs(UnmanagedType.LPStr)] string szControlName, [MarshalAs(UnmanagedType.LPStr)] string szBillboard);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiPreviewBillboardA' -Namespace Win32 -PassThru
# $api::MsiPreviewBillboardA(hPreview, szControlName, szBillboard)#uselib "msi.dll"
#func global MsiPreviewBillboardA "MsiPreviewBillboardA" sptr, sptr, sptr
; MsiPreviewBillboardA hPreview, szControlName, szBillboard ; 戻り値は stat
; hPreview : MSIHANDLE -> "sptr"
; szControlName : LPCSTR -> "sptr"
; szBillboard : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "msi.dll"
#cfunc global MsiPreviewBillboardA "MsiPreviewBillboardA" int, str, str
; res = MsiPreviewBillboardA(hPreview, szControlName, szBillboard)
; hPreview : MSIHANDLE -> "int"
; szControlName : LPCSTR -> "str"
; szBillboard : LPCSTR -> "str"; DWORD MsiPreviewBillboardA(MSIHANDLE hPreview, LPCSTR szControlName, LPCSTR szBillboard)
#uselib "msi.dll"
#cfunc global MsiPreviewBillboardA "MsiPreviewBillboardA" int, str, str
; res = MsiPreviewBillboardA(hPreview, szControlName, szBillboard)
; hPreview : MSIHANDLE -> "int"
; szControlName : LPCSTR -> "str"
; szBillboard : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiPreviewBillboardA = msi.NewProc("MsiPreviewBillboardA")
)
// hPreview (MSIHANDLE), szControlName (LPCSTR), szBillboard (LPCSTR)
r1, _, err := procMsiPreviewBillboardA.Call(
uintptr(hPreview),
uintptr(unsafe.Pointer(windows.BytePtrFromString(szControlName))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(szBillboard))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiPreviewBillboardA(
hPreview: DWORD; // MSIHANDLE
szControlName: PAnsiChar; // LPCSTR
szBillboard: PAnsiChar // LPCSTR
): DWORD; stdcall;
external 'msi.dll' name 'MsiPreviewBillboardA';result := DllCall("msi\MsiPreviewBillboardA"
, "UInt", hPreview ; MSIHANDLE
, "AStr", szControlName ; LPCSTR
, "AStr", szBillboard ; LPCSTR
, "UInt") ; return: DWORD●MsiPreviewBillboardA(hPreview, szControlName, szBillboard) = DLL("msi.dll", "dword MsiPreviewBillboardA(dword, char*, char*)")
# 呼び出し: MsiPreviewBillboardA(hPreview, szControlName, szBillboard)
# hPreview : MSIHANDLE -> "dword"
# szControlName : LPCSTR -> "char*"
# szBillboard : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "msi" fn MsiPreviewBillboardA(
hPreview: u32, // MSIHANDLE
szControlName: [*c]const u8, // LPCSTR
szBillboard: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) u32;proc MsiPreviewBillboardA(
hPreview: uint32, # MSIHANDLE
szControlName: cstring, # LPCSTR
szBillboard: cstring # LPCSTR
): uint32 {.importc: "MsiPreviewBillboardA", stdcall, dynlib: "msi.dll".}pragma(lib, "msi");
extern(Windows)
uint MsiPreviewBillboardA(
uint hPreview, // MSIHANDLE
const(char)* szControlName, // LPCSTR
const(char)* szBillboard // LPCSTR
);ccall((:MsiPreviewBillboardA, "msi.dll"), stdcall, UInt32,
(UInt32, Cstring, Cstring),
hPreview, szControlName, szBillboard)
# hPreview : MSIHANDLE -> UInt32
# szControlName : LPCSTR -> Cstring
# szBillboard : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiPreviewBillboardA(
uint32_t hPreview,
const char* szControlName,
const char* szBillboard);
]]
local msi = ffi.load("msi")
-- msi.MsiPreviewBillboardA(hPreview, szControlName, szBillboard)
-- hPreview : MSIHANDLE
-- szControlName : LPCSTR
-- szBillboard : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiPreviewBillboardA = lib.func('__stdcall', 'MsiPreviewBillboardA', 'uint32_t', ['uint32_t', 'str', 'str']);
// MsiPreviewBillboardA(hPreview, szControlName, szBillboard)
// hPreview : MSIHANDLE -> 'uint32_t'
// szControlName : LPCSTR -> 'str'
// szBillboard : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiPreviewBillboardA: { parameters: ["u32", "buffer", "buffer"], result: "u32" },
});
// lib.symbols.MsiPreviewBillboardA(hPreview, szControlName, szBillboard)
// hPreview : MSIHANDLE -> "u32"
// szControlName : LPCSTR -> "buffer"
// szBillboard : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiPreviewBillboardA(
uint32_t hPreview,
const char* szControlName,
const char* szBillboard);
C, "msi.dll");
// $ffi->MsiPreviewBillboardA(hPreview, szControlName, szBillboard);
// hPreview : MSIHANDLE
// szControlName : LPCSTR
// szBillboard : LPCSTR
// 構造体/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 MsiPreviewBillboardA(
int hPreview, // MSIHANDLE
String szControlName, // LPCSTR
String szBillboard // LPCSTR
);
}@[Link("msi")]
lib Libmsi
fun MsiPreviewBillboardA = MsiPreviewBillboardA(
hPreview : UInt32, # MSIHANDLE
szControlName : UInt8*, # LPCSTR
szBillboard : UInt8* # LPCSTR
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MsiPreviewBillboardANative = Uint32 Function(Uint32, Pointer<Utf8>, Pointer<Utf8>);
typedef MsiPreviewBillboardADart = int Function(int, Pointer<Utf8>, Pointer<Utf8>);
final MsiPreviewBillboardA = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiPreviewBillboardANative, MsiPreviewBillboardADart>('MsiPreviewBillboardA');
// hPreview : MSIHANDLE -> Uint32
// szControlName : LPCSTR -> Pointer<Utf8>
// szBillboard : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiPreviewBillboardA(
hPreview: DWORD; // MSIHANDLE
szControlName: PAnsiChar; // LPCSTR
szBillboard: PAnsiChar // LPCSTR
): DWORD; stdcall;
external 'msi.dll' name 'MsiPreviewBillboardA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiPreviewBillboardA"
c_MsiPreviewBillboardA :: Word32 -> CString -> CString -> IO Word32
-- hPreview : MSIHANDLE -> Word32
-- szControlName : LPCSTR -> CString
-- szBillboard : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msipreviewbillboarda =
foreign "MsiPreviewBillboardA"
(uint32_t @-> string @-> string @-> returning uint32_t)
(* hPreview : MSIHANDLE -> uint32_t *)
(* szControlName : LPCSTR -> string *)
(* szBillboard : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)
(cffi:defcfun ("MsiPreviewBillboardA" msi-preview-billboard-a :convention :stdcall) :uint32
(h-preview :uint32) ; MSIHANDLE
(sz-control-name :string) ; LPCSTR
(sz-billboard :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiPreviewBillboardA = Win32::API::More->new('msi',
'DWORD MsiPreviewBillboardA(DWORD hPreview, LPCSTR szControlName, LPCSTR szBillboard)');
# my $ret = $MsiPreviewBillboardA->Call($hPreview, $szControlName, $szBillboard);
# hPreview : MSIHANDLE -> DWORD
# szControlName : LPCSTR -> LPCSTR
# szBillboard : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f MsiPreviewBillboardW (Unicode版) — コントロール上にビルボードをプレビュー表示する(Unicode版)。