ホーム › System.ApplicationInstallationAndServicing › MsiGetUserInfoA

MsiGetUserInfoA

関数

製品に登録されたユーザー情報を取得する(ANSI版)。

DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

USERINFOSTATE MsiGetUserInfoA(
    LPCSTR szProduct,
    LPSTR lpUserNameBuf,   // optional
    DWORD* pcchUserNameBuf,   // optional
    LPSTR lpOrgNameBuf,   // optional
    DWORD* pcchOrgNameBuf,   // optional
    LPSTR lpSerialBuf,   // optional
    DWORD* pcchSerialBuf   // optional
);

パラメーター

名前	型	方向	説明
szProduct	LPCSTR	in	クエリ対象となる製品の製品コードを指定します。
lpUserNameBuf	LPSTR	outoptional	ユーザー名を受け取る変数へのポインターです。
pcchUserNameBuf	DWORD*	inoutoptional	lpUserNameBuf パラメーターが指すバッファーのサイズ(文字数単位)を指定する変数へのポインターです。このサイズには終端の null 文字分を含める必要があります。
lpOrgNameBuf	LPSTR	outoptional	組織名を受け取るバッファーへのポインターです。
pcchOrgNameBuf	DWORD*	inoutoptional	lpOrgNameBuf パラメーターが指すバッファーのサイズ(文字数単位)を指定する変数へのポインターです。入力時には、終端の null 文字分の領域を含むバッファー全体のサイズを指定します。渡されたバッファーが小さすぎる場合、返される文字数には終端の null 文字は含まれません。
lpSerialBuf	LPSTR	outoptional	製品 ID を受け取るバッファーへのポインターです。
pcchSerialBuf	DWORD*	inoutoptional	lpSerialBuf パラメーターが指すバッファーのサイズ(文字数単位)を指定する変数へのポインターです。入力時には、終端の null 文字分の領域を含むバッファー全体のサイズを指定します。渡されたバッファーが小さすぎる場合、返される文字数には終端の null 文字は含まれません。

戻り値の型: USERINFOSTATE

公式ドキュメント

MsiGetUserInfo 関数は、インストール済みの製品について登録されているユーザー情報を返します。(ANSI)

戻り値

値	意味
USERINFOSTATE_ABSENT	ユーザー情報の一部またはすべてが存在しません。
USERINFOSTATE_INVALIDARG	関数のパラメーターのいずれかが無効でした。
USERINFOSTATE_MOREDATA	バッファーが小さすぎて、要求されたデータを格納できません。
USERINFOSTATE_PRESENT	関数が正常に完了しました。
USERINFOSTATE_UNKNOWN	製品コードが既知の製品を識別していません。

解説(Remarks)

MsiGetUserInfo 関数が返るとき、pcchNameBuf パラメーターにはバッファーに格納された文字列の長さが含まれます。返される文字数には終端の null 文字は含まれません。バッファーが十分な大きさでない場合、MsiGetUserInfo 関数は USERINFOSTATE_MOREDATA を返し、MsiGetUserInfo には null 文字を数えない文字列のサイズ(文字数単位)が格納されます。

会社名が存在しない場合でも、ユーザー情報は存在するものとみなされます。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

USERINFOSTATE MsiGetUserInfoA(
    LPCSTR szProduct,
    LPSTR lpUserNameBuf,   // optional
    DWORD* pcchUserNameBuf,   // optional
    LPSTR lpOrgNameBuf,   // optional
    DWORD* pcchOrgNameBuf,   // optional
    LPSTR lpSerialBuf,   // optional
    DWORD* pcchSerialBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int MsiGetUserInfoA(
    [MarshalAs(UnmanagedType.LPStr)] string szProduct,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpUserNameBuf,   // LPSTR optional, out
    IntPtr pcchUserNameBuf,   // DWORD* optional, in/out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpOrgNameBuf,   // LPSTR optional, out
    IntPtr pcchOrgNameBuf,   // DWORD* optional, in/out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpSerialBuf,   // LPSTR optional, out
    IntPtr pcchSerialBuf   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiGetUserInfoA(
    <MarshalAs(UnmanagedType.LPStr)> szProduct As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpUserNameBuf As System.Text.StringBuilder,   ' LPSTR optional, out
    pcchUserNameBuf As IntPtr,   ' DWORD* optional, in/out
    <MarshalAs(UnmanagedType.LPStr)> lpOrgNameBuf As System.Text.StringBuilder,   ' LPSTR optional, out
    pcchOrgNameBuf As IntPtr,   ' DWORD* optional, in/out
    <MarshalAs(UnmanagedType.LPStr)> lpSerialBuf As System.Text.StringBuilder,   ' LPSTR optional, out
    pcchSerialBuf As IntPtr   ' DWORD* optional, in/out
) As Integer
End Function

' szProduct : LPCSTR
' lpUserNameBuf : LPSTR optional, out
' pcchUserNameBuf : DWORD* optional, in/out
' lpOrgNameBuf : LPSTR optional, out
' pcchOrgNameBuf : DWORD* optional, in/out
' lpSerialBuf : LPSTR optional, out
' pcchSerialBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiGetUserInfoA Lib "msi" ( _
    ByVal szProduct As String, _
    ByVal lpUserNameBuf As String, _
    ByVal pcchUserNameBuf As LongPtr, _
    ByVal lpOrgNameBuf As String, _
    ByVal pcchOrgNameBuf As LongPtr, _
    ByVal lpSerialBuf As String, _
    ByVal pcchSerialBuf As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiGetUserInfoA = ctypes.windll.msi.MsiGetUserInfoA
MsiGetUserInfoA.restype = ctypes.c_int
MsiGetUserInfoA.argtypes = [
    wintypes.LPCSTR,  # szProduct : LPCSTR
    wintypes.LPSTR,  # lpUserNameBuf : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchUserNameBuf : DWORD* optional, in/out
    wintypes.LPSTR,  # lpOrgNameBuf : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchOrgNameBuf : DWORD* optional, in/out
    wintypes.LPSTR,  # lpSerialBuf : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchSerialBuf : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetUserInfoA = Fiddle::Function.new(
  lib['MsiGetUserInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # szProduct : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpUserNameBuf : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchUserNameBuf : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpOrgNameBuf : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchOrgNameBuf : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpSerialBuf : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchSerialBuf : DWORD* optional, in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiGetUserInfoA(
        szProduct: *const u8,  // LPCSTR
        lpUserNameBuf: *mut u8,  // LPSTR optional, out
        pcchUserNameBuf: *mut u32,  // DWORD* optional, in/out
        lpOrgNameBuf: *mut u8,  // LPSTR optional, out
        pcchOrgNameBuf: *mut u32,  // DWORD* optional, in/out
        lpSerialBuf: *mut u8,  // LPSTR optional, out
        pcchSerialBuf: *mut u32  // DWORD* optional, in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern int MsiGetUserInfoA([MarshalAs(UnmanagedType.LPStr)] string szProduct, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpUserNameBuf, IntPtr pcchUserNameBuf, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpOrgNameBuf, IntPtr pcchOrgNameBuf, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpSerialBuf, IntPtr pcchSerialBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetUserInfoA' -Namespace Win32 -PassThru
# $api::MsiGetUserInfoA(szProduct, lpUserNameBuf, pcchUserNameBuf, lpOrgNameBuf, pcchOrgNameBuf, lpSerialBuf, pcchSerialBuf)

#uselib "msi.dll"
#func global MsiGetUserInfoA "MsiGetUserInfoA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; MsiGetUserInfoA szProduct, varptr(lpUserNameBuf), varptr(pcchUserNameBuf), varptr(lpOrgNameBuf), varptr(pcchOrgNameBuf), varptr(lpSerialBuf), varptr(pcchSerialBuf)   ; 戻り値は stat
; szProduct : LPCSTR -> "sptr"
; lpUserNameBuf : LPSTR optional, out -> "sptr"
; pcchUserNameBuf : DWORD* optional, in/out -> "sptr"
; lpOrgNameBuf : LPSTR optional, out -> "sptr"
; pcchOrgNameBuf : DWORD* optional, in/out -> "sptr"
; lpSerialBuf : LPSTR optional, out -> "sptr"
; pcchSerialBuf : DWORD* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiGetUserInfoA "MsiGetUserInfoA" str, var, var, var, var, var, var
; res = MsiGetUserInfoA(szProduct, lpUserNameBuf, pcchUserNameBuf, lpOrgNameBuf, pcchOrgNameBuf, lpSerialBuf, pcchSerialBuf)
; szProduct : LPCSTR -> "str"
; lpUserNameBuf : LPSTR optional, out -> "var"
; pcchUserNameBuf : DWORD* optional, in/out -> "var"
; lpOrgNameBuf : LPSTR optional, out -> "var"
; pcchOrgNameBuf : DWORD* optional, in/out -> "var"
; lpSerialBuf : LPSTR optional, out -> "var"
; pcchSerialBuf : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiGetUserInfoA "MsiGetUserInfoA" str, sptr, sptr, sptr, sptr, sptr, sptr
; res = MsiGetUserInfoA(szProduct, varptr(lpUserNameBuf), varptr(pcchUserNameBuf), varptr(lpOrgNameBuf), varptr(pcchOrgNameBuf), varptr(lpSerialBuf), varptr(pcchSerialBuf))
; szProduct : LPCSTR -> "str"
; lpUserNameBuf : LPSTR optional, out -> "sptr"
; pcchUserNameBuf : DWORD* optional, in/out -> "sptr"
; lpOrgNameBuf : LPSTR optional, out -> "sptr"
; pcchOrgNameBuf : DWORD* optional, in/out -> "sptr"
; lpSerialBuf : LPSTR optional, out -> "sptr"
; pcchSerialBuf : DWORD* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。