GetFileMUIInfo

関数

指定ファイルのMUIリソース構成情報を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL GetFileMUIInfo(
    DWORD dwFlags,
    LPCWSTR pcwszFilePath,
    FILEMUIINFO* pFileMUIInfo,   // optional
    DWORD* pcbFileMUIInfo
);

パラメーター

名前

型

方向

説明

dwFlags

DWORD

取得する情報を指定するフラグです。次のフラグの任意の組み合わせを指定できます。フラグの既定値は MUI_QUERY_TYPE | MUI_QUERY_CHECKSUM です。

値	意味
MUI_QUERY_TYPE	FILEMUIINFO の dwFileType メンバーに、次のいずれかの値を取得します。 MUI_FILETYPE_NOT_LANGUAGE_NEUTRAL: 指定された入力ファイルにはリソース構成データがありません。したがって、LN ファイルでも言語固有のリソースファイルでもありません。この種類のファイルは古い実行可能ファイルに典型的です。このファイル種別が指定された場合、関数は他の種別に関する有用な情報を取得しません。 MUI_FILETYPE_LANGUAGE_NEUTRAL_MAIN. 入力ファイルは LN ファイルです。 MUI_FILETYPE_LANGUAGE_NEUTRAL_MUI. 入力ファイルは LN ファイルに関連付けられた言語固有のリソースファイルです。
MUI_QUERY_CHECKSUM	入力ファイルのリソースチェックサムを FILEMUIINFO の pChecksum メンバーに取得します。入力ファイルにリソース構成データがない場合、この構造体メンバーには 0 が格納されます。
MUI_QUERY_LANGUAGE_NAME	入力ファイルに関連付けられた言語を取得します。言語固有のリソースファイルの場合、このフラグは関連付けられた言語を要求します。LN ファイルの場合、このフラグはモジュールの最終フォールバックリソースの言語を要求します。これは LN ファイル内にある場合と、LN ファイルのリソース構成データから参照される別個の言語固有のリソースファイル内にある場合があります。詳細については「解説」のセクションを参照してください。
MUI_QUERY_RESOURCE_TYPES	リソース構成データで指定されているとおりに、言語固有のリソースファイルおよび LN ファイル内のリソース種別の一覧を取得します。この情報にアクセスする方法については「解説」のセクションを参照してください。

pcwszFilePath

LPCWSTR

ファイルへのパスを示す null 終端文字列へのポインターです。通常、ファイルは LN ファイルまたは言語固有のリソースファイルのいずれかです。これらの種別のいずれでもない場合、関数が取得する有意な値は MUI_FILETYPE_NOT_LANGUAGE_NEUTRAL のみです。関数がこの値を取得するのは、MUI_QUERY_RESOURCE_TYPES フラグが設定されている場合だけです。

pFileMUIInfo

FILEMUIINFO*

inoutoptional

FILEMUIINFO 構造体内、および場合によってはその構造体に続くデータ内のファイル情報を格納するバッファーへのポインターです。情報バッファーは、構造体自体のサイズよりもはるかに大きくする必要がある場合があります。フラグの設定によっては、関数は構造体に続けて、構造体内で取得されるオフセットの位置にかなりの量の情報を格納できます。詳細については「解説」のセクションを参照してください。

あるいは、pcbFileMUIInfo を 0 に設定する場合、アプリケーションはこのパラメーターに NULL を設定できます。この場合、関数は情報バッファーに必要なサイズを pcbFileMUIInfo に取得します。

注意 pFileMUIInfo の値が NULL でない場合、dwSize メンバーには FILEMUIINFO 構造体のサイズ(情報バッファーを含む)を設定し、dwVersion メンバーには現在のバージョンである 0x001 を設定する必要があります。

pcbFileMUIInfo

DWORD*

inout

pFileMUIInfo で示されるファイル情報用のバッファーサイズ(バイト単位)へのポインターです。関数が正常に戻ると、このパラメーターには取得されたファイル情報バッファーと、それを格納する FILEMUIINFO 構造体のサイズが格納されます。

あるいは、pFileMUIInfo に NULL を設定する場合、アプリケーションはこのパラメーターを 0 に設定できます。この場合、関数は必要なファイル情報バッファーサイズを pcbFileMUIInfo に取得します。正しい量のメモリを割り当てるには、この値を FILEMUIINFO 構造体自体のサイズに加算する必要があります。

注意 pFileMUIInfo の値が NULL でない場合、このパラメーターの値は FILEMUIINFO の dwSize メンバーの値と一致する必要があります。

戻り値の型: BOOL

公式ドキュメント

ファイルに関するリソース関連情報を取得します。

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができます。

解説(Remarks)

MUI_QUERY_LANGUAGE_NAME フラグの場合、この関数は FILEMUIINFO の先頭からのオフセット(バイト単位)を dwLanguageNameOffset メンバーに取得します。

次は、入力ファイルに関連付けられた言語名にアクセスするサンプルコードです。

LPWSTR lpszLang = reinterpret_cast<LPWSTR>(
        reinterpret_cast<BYTE*>(pFileMUIInfo) +
        pFileMUIInfo->dwLanguageNameOffset);

MUI_QUERY_RESOURCE_TYPES フラグの場合、この関数は言語固有のリソースファイル情報を次の FILEMUIINFO メンバーに取得します。

dwTypeIDMUIOffset メンバーには、言語固有のリソースファイルに含まれるリソースの識別子の配列へのオフセットが格納されます。
dwTypeIDMUISize メンバーには、言語固有のリソースファイル用のリソース識別子配列のサイズが格納されます。
dwTypeNameMUIOffset メンバーには、言語固有のリソースファイルに含まれるリソースの名前の配列へのオフセットが格納されます。

入力ファイルが LN ファイルの場合、関数は上記のすべての構造体メンバーを設定します。さらに、次のメンバーも設定します。

dwTypeIDMainOffset メンバーには、LN ファイルに含まれるリソースの識別子の配列へのオフセットが格納されます。
dwTypeIDMainSize メンバーには、LN ファイル用のリソース識別子配列のサイズが格納されます。
dwTypeNameMainOffset メンバーには、ファイルに含まれるリソースの名前の配列へのオフセットが格納されます。

次は、LN ファイル内のリソース識別子の配列にアクセスするサンプルコードです。

DWORD *pdwTypeID = reinterpret_cast<DWORD *>(
        reinterpret_cast<BYTE*>(pFileMUIInfo) +
        pFileMUIInfo->dwTypeIDMainOffset);

注意言語固有のリソースの一覧も同じ方法でアクセスします。

次は、LN ファイル内のリソース名のマルチストリング配列にアクセスするサンプルコードです。

LPWSTR lpszNames = reinterpret_cast<LPWSTR>(
        reinterpret_cast<BYTE*>(pFileMUIInfo) +
        pFileMUIInfo->dwTypeNameMainOffset);

注意言語固有のリソースの一覧も同じ方法でアクセスします。

各コードサンプルでは 2 つの reinterpret cast を使用しています。まず BYTE* にキャストし、オフセットのポインター演算がバイト単位で行われるようにします。次に、得られたポインターを目的の型にキャストします。

別の方法として、サンプルに示したコードの代わりに次のように記述することもできます。効果は同じであり、選択は単にスタイルの問題です。

DWORD ix = pFileMUIInfo->dwLanguageNameOffset - 
        offsetof(struct _FILEMUIINFO, abBuffer);
LPWSTR lpszLang = reinterpret_cast<LPWSTR>(&(pFileMUIInfo->abBuffer[ix]));

C# シグネチャ

[DllImport("Kernel32.dll", CharSet = CharSet.Auto)]
        static extern System.Boolean GetFileMUIInfo(
            System.UInt32 dwFlags,
            System.String pcwszFilePath,
            ref FILEMUIINFO pFileMUIInfo,
            ref System.UInt32 pcbFileMUIInfo
            );

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL GetFileMUIInfo(
    DWORD dwFlags,
    LPCWSTR pcwszFilePath,
    FILEMUIINFO* pFileMUIInfo,   // optional
    DWORD* pcbFileMUIInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetFileMUIInfo(
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pcwszFilePath,   // LPCWSTR
    IntPtr pFileMUIInfo,   // FILEMUIINFO* optional, in/out
    ref uint pcbFileMUIInfo   // DWORD* in/out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFileMUIInfo(
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pcwszFilePath As String,   ' LPCWSTR
    pFileMUIInfo As IntPtr,   ' FILEMUIINFO* optional, in/out
    ByRef pcbFileMUIInfo As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwFlags : DWORD
' pcwszFilePath : LPCWSTR
' pFileMUIInfo : FILEMUIINFO* optional, in/out
' pcbFileMUIInfo : DWORD* in/out
Declare PtrSafe Function GetFileMUIInfo Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal pcwszFilePath As LongPtr, _
    ByVal pFileMUIInfo As LongPtr, _
    ByRef pcbFileMUIInfo As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetFileMUIInfo = ctypes.windll.kernel32.GetFileMUIInfo
GetFileMUIInfo.restype = wintypes.BOOL
GetFileMUIInfo.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # pcwszFilePath : LPCWSTR
    ctypes.c_void_p,  # pFileMUIInfo : FILEMUIINFO* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # pcbFileMUIInfo : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetFileMUIInfo = Fiddle::Function.new(
  lib['GetFileMUIInfo'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pcwszFilePath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pFileMUIInfo : FILEMUIINFO* optional, in/out
    Fiddle::TYPE_VOIDP,  # pcbFileMUIInfo : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetFileMUIInfo(
        dwFlags: u32,  // DWORD
        pcwszFilePath: *const u16,  // LPCWSTR
        pFileMUIInfo: *mut FILEMUIINFO,  // FILEMUIINFO* optional, in/out
        pcbFileMUIInfo: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetFileMUIInfo(uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string pcwszFilePath, IntPtr pFileMUIInfo, ref uint pcbFileMUIInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetFileMUIInfo' -Namespace Win32 -PassThru
# $api::GetFileMUIInfo(dwFlags, pcwszFilePath, pFileMUIInfo, pcbFileMUIInfo)

#uselib "KERNEL32.dll"
#func global GetFileMUIInfo "GetFileMUIInfo" sptr, sptr, sptr, sptr
; GetFileMUIInfo dwFlags, pcwszFilePath, varptr(pFileMUIInfo), varptr(pcbFileMUIInfo)   ; 戻り値は stat
; dwFlags : DWORD -> "sptr"
; pcwszFilePath : LPCWSTR -> "sptr"
; pFileMUIInfo : FILEMUIINFO* optional, in/out -> "sptr"
; pcbFileMUIInfo : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetFileMUIInfo "GetFileMUIInfo" int, wstr, var, var
; res = GetFileMUIInfo(dwFlags, pcwszFilePath, pFileMUIInfo, pcbFileMUIInfo)
; dwFlags : DWORD -> "int"
; pcwszFilePath : LPCWSTR -> "wstr"
; pFileMUIInfo : FILEMUIINFO* optional, in/out -> "var"
; pcbFileMUIInfo : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetFileMUIInfo "GetFileMUIInfo" int, wstr, sptr, sptr
; res = GetFileMUIInfo(dwFlags, pcwszFilePath, varptr(pFileMUIInfo), varptr(pcbFileMUIInfo))
; dwFlags : DWORD -> "int"
; pcwszFilePath : LPCWSTR -> "wstr"
; pFileMUIInfo : FILEMUIINFO* optional, in/out -> "sptr"
; pcbFileMUIInfo : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。