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

MsiCollectUserInfoA

関数
製品のユーザー情報を収集ダイアログで取得する(ANSI版)。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiCollectUserInfoA(
    LPCSTR szProduct
);

パラメーター

名前方向説明
szProductLPCSTRinユーザー情報を収集する対象の製品のプロダクトコードを指定します。

戻り値の型: DWORD

公式ドキュメント

MsiCollectUserInfo 関数は、インストールウィザードからユーザー情報と製品 ID を取得して保存します。(ANSI)

戻り値

意味
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。
ERROR_SUCCESS
関数が成功しました。
アクションに関連するエラー

Error Codes を参照してください。

初期化エラー
初期化に関連するエラーが発生しました。

解説(Remarks)

MsiCollectUserInfo 関数は、通常、アプリケーションの初回実行時に呼び出されます。アプリケーションは最初に MsiGetUserInfo を呼び出します。その呼び出しが失敗した場合、アプリケーションは MsiCollectUserInfo を呼び出します。 MsiCollectUserInfo は製品のインストールパッケージを開き、ユーザー情報を収集するウィザードシーケンスを起動します。シーケンスの完了時に、ユーザー情報が登録されます。この API はオーサリングされたユーザーインターフェイスを必要とするため、 MsiSetInternalUIINSTALLUILEVEL_FULL として呼び出し、ユーザーインターフェイスのレベルを full に設定する必要があります。

MsiCollectUserInfoFirstRun Dialog を起動します。

メモ

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

MsiCollectUserInfoA = ctypes.windll.msi.MsiCollectUserInfoA
MsiCollectUserInfoA.restype = wintypes.DWORD
MsiCollectUserInfoA.argtypes = [
    wintypes.LPCSTR,  # szProduct : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiCollectUserInfoA = Fiddle::Function.new(
  lib['MsiCollectUserInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # szProduct : LPCSTR
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiCollectUserInfoA(
        szProduct: *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 MsiCollectUserInfoA([MarshalAs(UnmanagedType.LPStr)] string szProduct);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiCollectUserInfoA' -Namespace Win32 -PassThru
# $api::MsiCollectUserInfoA(szProduct)
#uselib "msi.dll"
#func global MsiCollectUserInfoA "MsiCollectUserInfoA" sptr
; MsiCollectUserInfoA szProduct   ; 戻り値は stat
; szProduct : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiCollectUserInfoA "MsiCollectUserInfoA" str
; res = MsiCollectUserInfoA(szProduct)
; szProduct : LPCSTR -> "str"
; DWORD MsiCollectUserInfoA(LPCSTR szProduct)
#uselib "msi.dll"
#cfunc global MsiCollectUserInfoA "MsiCollectUserInfoA" str
; res = MsiCollectUserInfoA(szProduct)
; szProduct : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiCollectUserInfoA = msi.NewProc("MsiCollectUserInfoA")
)

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

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

foreign import stdcall safe "MsiCollectUserInfoA"
  c_MsiCollectUserInfoA :: CString -> IO Word32
-- szProduct : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msicollectuserinfoa =
  foreign "MsiCollectUserInfoA"
    (string @-> returning uint32_t)
(* szProduct : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiCollectUserInfoA" msi-collect-user-info-a :convention :stdcall) :uint32
  (sz-product :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiCollectUserInfoA = Win32::API::More->new('msi',
    'DWORD MsiCollectUserInfoA(LPCSTR szProduct)');
# my $ret = $MsiCollectUserInfoA->Call($szProduct);
# szProduct : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い