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

MsiCollectUserInfoW

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

シグネチャ

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

DWORD MsiCollectUserInfoW(
    LPCWSTR szProduct
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

意味
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。
ERROR_SUCCESS
関数は成功しました。
アクションに関連するエラー
エラーコード を参照してください。
初期化エラー
初期化に関連するエラーが発生しました。

解説(Remarks)

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

MsiCollectUserInfoFirstRun Dialog を起動します。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiCollectUserInfoW(
    LPCWSTR szProduct
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiCollectUserInfoW(
    [MarshalAs(UnmanagedType.LPWStr)] string szProduct   // LPCWSTR
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiCollectUserInfoW(
    <MarshalAs(UnmanagedType.LPWStr)> szProduct As String   ' LPCWSTR
) As UInteger
End Function
' szProduct : LPCWSTR
Declare PtrSafe Function MsiCollectUserInfoW Lib "msi" ( _
    ByVal szProduct 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

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

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiCollectUserInfoW = msi.NewProc("MsiCollectUserInfoW")
)

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

extern "msi" fn MsiCollectUserInfoW(
    szProduct: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiCollectUserInfoW(
    szProduct: WideCString  # LPCWSTR
): uint32 {.importc: "MsiCollectUserInfoW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
uint MsiCollectUserInfoW(
    const(wchar)* szProduct   // LPCWSTR
);
ccall((:MsiCollectUserInfoW, "msi.dll"), stdcall, UInt32,
      (Cwstring,),
      szProduct)
# szProduct : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiCollectUserInfoW(
    const uint16_t* szProduct);
]]
local msi = ffi.load("msi")
-- msi.MsiCollectUserInfoW(szProduct)
-- szProduct : 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 MsiCollectUserInfoW = lib.func('__stdcall', 'MsiCollectUserInfoW', 'uint32_t', ['str16']);
// MsiCollectUserInfoW(szProduct)
// szProduct : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiCollectUserInfoW: { parameters: ["buffer"], result: "u32" },
});
// lib.symbols.MsiCollectUserInfoW(szProduct)
// szProduct : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiCollectUserInfoW(
    const uint16_t* szProduct);
C, "msi.dll");
// $ffi->MsiCollectUserInfoW(szProduct);
// szProduct : 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 MsiCollectUserInfoW(
        WString szProduct   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiCollectUserInfoW = MsiCollectUserInfoW(
    szProduct : 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 MsiCollectUserInfoWNative = Uint32 Function(Pointer<Utf16>);
typedef MsiCollectUserInfoWDart = int Function(Pointer<Utf16>);
final MsiCollectUserInfoW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiCollectUserInfoWNative, MsiCollectUserInfoWDart>('MsiCollectUserInfoW');
// szProduct : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiCollectUserInfoW(
  szProduct: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'msi.dll' name 'MsiCollectUserInfoW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let msicollectuserinfow =
  foreign "MsiCollectUserInfoW"
    ((ptr uint16_t) @-> returning uint32_t)
(* szProduct : 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 ("MsiCollectUserInfoW" msi-collect-user-info-w :convention :stdcall) :uint32
  (sz-product (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiCollectUserInfoW = Win32::API::More->new('msi',
    'DWORD MsiCollectUserInfoW(LPCWSTR szProduct)');
# my $ret = $MsiCollectUserInfoW->Call($szProduct);
# szProduct : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い