ホーム › System.ApplicationInstallationAndServicing › MsiIsProductElevatedW
MsiIsProductElevatedW
関数指定製品が昇格された権限でインストールされているか判定する。
シグネチャ
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiIsProductElevatedW(
LPCWSTR szProduct,
BOOL* pfElevated
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| szProduct | LPCWSTR | in | 製品の完全な製品コード GUID。 このパラメーターは必須であり、NULL または空にすることはできません。 |
| pfElevated | BOOL* | out | 結果を格納する BOOL へのポインター。 このパラメーターを NULL にすることはできません。 |
戻り値の型: DWORD
公式ドキュメント
MsiIsProductElevated 関数は、製品が管理対象であるかどうかを返します。(Unicode)
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS となり、製品が管理対象アプリケーションであれば pfElevated に TRUE が設定されます。
関数が失敗した場合、戻り値は次の表に示すエラーコードのいずれかになります。
| 戻り値 | 説明 |
|---|---|
| 製品が現在認識されていません。 | |
| 無効な引数が関数に渡されました。 | |
| 製品の構成情報が無効です。 | |
| 関数が失敗しました。 | |
| 特定のプラットフォームではこの関数を利用できません。 |
解説(Remarks)
メモ
msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiIsProductElevated を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不整合が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、「関数プロトタイプの規則」を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 (Unicode / -W)
#include <windows.h>
DWORD MsiIsProductElevatedW(
LPCWSTR szProduct,
BOOL* pfElevated
);[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiIsProductElevatedW(
[MarshalAs(UnmanagedType.LPWStr)] string szProduct, // LPCWSTR
out bool pfElevated // BOOL* out
);<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiIsProductElevatedW(
<MarshalAs(UnmanagedType.LPWStr)> szProduct As String, ' LPCWSTR
<Out> ByRef pfElevated As Boolean ' BOOL* out
) As UInteger
End Function' szProduct : LPCWSTR
' pfElevated : BOOL* out
Declare PtrSafe Function MsiIsProductElevatedW Lib "msi" ( _
ByVal szProduct As LongPtr, _
ByRef pfElevated As Long) 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
MsiIsProductElevatedW = ctypes.windll.msi.MsiIsProductElevatedW
MsiIsProductElevatedW.restype = wintypes.DWORD
MsiIsProductElevatedW.argtypes = [
wintypes.LPCWSTR, # szProduct : LPCWSTR
ctypes.c_void_p, # pfElevated : BOOL* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiIsProductElevatedW = Fiddle::Function.new(
lib['MsiIsProductElevatedW'],
[
Fiddle::TYPE_VOIDP, # szProduct : LPCWSTR
Fiddle::TYPE_VOIDP, # pfElevated : BOOL* out
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "msi")]
extern "system" {
fn MsiIsProductElevatedW(
szProduct: *const u16, // LPCWSTR
pfElevated: *mut i32 // BOOL* out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiIsProductElevatedW([MarshalAs(UnmanagedType.LPWStr)] string szProduct, out bool pfElevated);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiIsProductElevatedW' -Namespace Win32 -PassThru
# $api::MsiIsProductElevatedW(szProduct, pfElevated)#uselib "msi.dll"
#func global MsiIsProductElevatedW "MsiIsProductElevatedW" wptr, wptr
; MsiIsProductElevatedW szProduct, varptr(pfElevated) ; 戻り値は stat
; szProduct : LPCWSTR -> "wptr"
; pfElevated : BOOL* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "msi.dll" #cfunc global MsiIsProductElevatedW "MsiIsProductElevatedW" wstr, var ; res = MsiIsProductElevatedW(szProduct, pfElevated) ; szProduct : LPCWSTR -> "wstr" ; pfElevated : BOOL* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll" #cfunc global MsiIsProductElevatedW "MsiIsProductElevatedW" wstr, sptr ; res = MsiIsProductElevatedW(szProduct, varptr(pfElevated)) ; szProduct : LPCWSTR -> "wstr" ; pfElevated : BOOL* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD MsiIsProductElevatedW(LPCWSTR szProduct, BOOL* pfElevated) #uselib "msi.dll" #cfunc global MsiIsProductElevatedW "MsiIsProductElevatedW" wstr, var ; res = MsiIsProductElevatedW(szProduct, pfElevated) ; szProduct : LPCWSTR -> "wstr" ; pfElevated : BOOL* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD MsiIsProductElevatedW(LPCWSTR szProduct, BOOL* pfElevated) #uselib "msi.dll" #cfunc global MsiIsProductElevatedW "MsiIsProductElevatedW" wstr, intptr ; res = MsiIsProductElevatedW(szProduct, varptr(pfElevated)) ; szProduct : LPCWSTR -> "wstr" ; pfElevated : BOOL* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiIsProductElevatedW = msi.NewProc("MsiIsProductElevatedW")
)
// szProduct (LPCWSTR), pfElevated (BOOL* out)
r1, _, err := procMsiIsProductElevatedW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szProduct))),
uintptr(pfElevated),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiIsProductElevatedW(
szProduct: PWideChar; // LPCWSTR
pfElevated: Pointer // BOOL* out
): DWORD; stdcall;
external 'msi.dll' name 'MsiIsProductElevatedW';result := DllCall("msi\MsiIsProductElevatedW"
, "WStr", szProduct ; LPCWSTR
, "Ptr", pfElevated ; BOOL* out
, "UInt") ; return: DWORD●MsiIsProductElevatedW(szProduct, pfElevated) = DLL("msi.dll", "dword MsiIsProductElevatedW(char*, void*)")
# 呼び出し: MsiIsProductElevatedW(szProduct, pfElevated)
# szProduct : LPCWSTR -> "char*"
# pfElevated : BOOL* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "msi" fn MsiIsProductElevatedW(
szProduct: [*c]const u16, // LPCWSTR
pfElevated: [*c]i32 // BOOL* out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc MsiIsProductElevatedW(
szProduct: WideCString, # LPCWSTR
pfElevated: ptr int32 # BOOL* out
): uint32 {.importc: "MsiIsProductElevatedW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "msi");
extern(Windows)
uint MsiIsProductElevatedW(
const(wchar)* szProduct, // LPCWSTR
int* pfElevated // BOOL* out
);ccall((:MsiIsProductElevatedW, "msi.dll"), stdcall, UInt32,
(Cwstring, Ptr{Int32}),
szProduct, pfElevated)
# szProduct : LPCWSTR -> Cwstring
# pfElevated : BOOL* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiIsProductElevatedW(
const uint16_t* szProduct,
int32_t* pfElevated);
]]
local msi = ffi.load("msi")
-- msi.MsiIsProductElevatedW(szProduct, pfElevated)
-- szProduct : LPCWSTR
-- pfElevated : BOOL* out
-- 構造体/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 MsiIsProductElevatedW = lib.func('__stdcall', 'MsiIsProductElevatedW', 'uint32_t', ['str16', 'int32_t *']);
// MsiIsProductElevatedW(szProduct, pfElevated)
// szProduct : LPCWSTR -> 'str16'
// pfElevated : BOOL* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiIsProductElevatedW: { parameters: ["buffer", "pointer"], result: "u32" },
});
// lib.symbols.MsiIsProductElevatedW(szProduct, pfElevated)
// szProduct : LPCWSTR -> "buffer"
// pfElevated : BOOL* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiIsProductElevatedW(
const uint16_t* szProduct,
int32_t* pfElevated);
C, "msi.dll");
// $ffi->MsiIsProductElevatedW(szProduct, pfElevated);
// szProduct : LPCWSTR
// pfElevated : BOOL* out
// 構造体/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 MsiIsProductElevatedW(
WString szProduct, // LPCWSTR
IntByReference pfElevated // BOOL* out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("msi")]
lib Libmsi
fun MsiIsProductElevatedW = MsiIsProductElevatedW(
szProduct : UInt16*, # LPCWSTR
pfElevated : Int32* # BOOL* out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MsiIsProductElevatedWNative = Uint32 Function(Pointer<Utf16>, Pointer<Int32>);
typedef MsiIsProductElevatedWDart = int Function(Pointer<Utf16>, Pointer<Int32>);
final MsiIsProductElevatedW = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiIsProductElevatedWNative, MsiIsProductElevatedWDart>('MsiIsProductElevatedW');
// szProduct : LPCWSTR -> Pointer<Utf16>
// pfElevated : BOOL* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiIsProductElevatedW(
szProduct: PWideChar; // LPCWSTR
pfElevated: Pointer // BOOL* out
): DWORD; stdcall;
external 'msi.dll' name 'MsiIsProductElevatedW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiIsProductElevatedW"
c_MsiIsProductElevatedW :: CWString -> Ptr CInt -> IO Word32
-- szProduct : LPCWSTR -> CWString
-- pfElevated : BOOL* out -> Ptr CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msiisproductelevatedw =
foreign "MsiIsProductElevatedW"
((ptr uint16_t) @-> (ptr int32_t) @-> returning uint32_t)
(* szProduct : LPCWSTR -> (ptr uint16_t) *)
(* pfElevated : BOOL* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)
(cffi:defcfun ("MsiIsProductElevatedW" msi-is-product-elevated-w :convention :stdcall) :uint32
(sz-product (:string :encoding :utf-16le)) ; LPCWSTR
(pf-elevated :pointer)) ; BOOL* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiIsProductElevatedW = Win32::API::More->new('msi',
'DWORD MsiIsProductElevatedW(LPCWSTR szProduct, LPVOID pfElevated)');
# my $ret = $MsiIsProductElevatedW->Call($szProduct, $pfElevated);
# szProduct : LPCWSTR -> LPCWSTR
# pfElevated : BOOL* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f MsiIsProductElevatedA (ANSI版) — 指定製品が昇格された権限でインストールされているか判定する。