ホーム › UI.WindowsAndMessaging › IndexFilePath

IndexFilePath

関数

指定ファイルパスをインデックス化し修飾子情報を返す。

DLLMrmSupport.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT IndexFilePath(
    void* resourceIndexer,
    LPCWSTR filePath,
    LPWSTR* ppResourceUri,
    DWORD* pQualifierCount,
    IndexedResourceQualifier** ppQualifiers
);

パラメーター

名前	型	方向	説明
resourceIndexer	void*	in	CreateResourceIndexer 関数を呼び出して作成したリソースインデクサーオブジェクト。
filePath	LPCWSTR	in	インデックスするフォルダーのパス。パスはドライブ文字を指定した絶対パスである必要があります。長いファイルパスはサポートされていません。
ppResourceUri	LPWSTR*	out	ms-resource URI スキームを使用し、候補の名前付きリソースを表す URI (Uniform Resource Indicator)。URI の権限部分、すなわちリソースマップは空です。たとえば ms-resource:///Resources/String1 や ms-resource:///Files/images/logo.png などです。
pQualifierCount	DWORD*	out	ppQualifiers パラメーターのリストに含まれる、インデックスされたリソース修飾子の数。
ppQualifiers	IndexedResourceQualifier**	out	リソースが適切となるコンテキストを宣言する、インデックスされたリソース修飾子のリスト。

戻り値の型: HRESULT

公式ドキュメント

ファイルおよびフォルダーの命名規則に従って、ファイルパスをインデックスします。

戻り値

この関数が成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

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

各言語での呼び出し定義

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

HRESULT IndexFilePath(
    void* resourceIndexer,
    LPCWSTR filePath,
    LPWSTR* ppResourceUri,
    DWORD* pQualifierCount,
    IndexedResourceQualifier** ppQualifiers
);

[DllImport("MrmSupport.dll", ExactSpelling = true)]
static extern int IndexFilePath(
    IntPtr resourceIndexer,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] string filePath,   // LPCWSTR
    IntPtr ppResourceUri,   // LPWSTR* out
    out uint pQualifierCount,   // DWORD* out
    IntPtr ppQualifiers   // IndexedResourceQualifier** out
);

<DllImport("MrmSupport.dll", ExactSpelling:=True)>
Public Shared Function IndexFilePath(
    resourceIndexer As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> filePath As String,   ' LPCWSTR
    ppResourceUri As IntPtr,   ' LPWSTR* out
    <Out> ByRef pQualifierCount As UInteger,   ' DWORD* out
    ppQualifiers As IntPtr   ' IndexedResourceQualifier** out
) As Integer
End Function

' resourceIndexer : void*
' filePath : LPCWSTR
' ppResourceUri : LPWSTR* out
' pQualifierCount : DWORD* out
' ppQualifiers : IndexedResourceQualifier** out
Declare PtrSafe Function IndexFilePath Lib "mrmsupport" ( _
    ByVal resourceIndexer As LongPtr, _
    ByVal filePath As LongPtr, _
    ByVal ppResourceUri As LongPtr, _
    ByRef pQualifierCount As Long, _
    ByVal ppQualifiers As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

IndexFilePath = ctypes.windll.mrmsupport.IndexFilePath
IndexFilePath.restype = ctypes.c_int
IndexFilePath.argtypes = [
    ctypes.POINTER(None),  # resourceIndexer : void*
    wintypes.LPCWSTR,  # filePath : LPCWSTR
    ctypes.c_void_p,  # ppResourceUri : LPWSTR* out
    ctypes.POINTER(wintypes.DWORD),  # pQualifierCount : DWORD* out
    ctypes.c_void_p,  # ppQualifiers : IndexedResourceQualifier** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MrmSupport.dll')
IndexFilePath = Fiddle::Function.new(
  lib['IndexFilePath'],
  [
    Fiddle::TYPE_VOIDP,  # resourceIndexer : void*
    Fiddle::TYPE_VOIDP,  # filePath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # ppResourceUri : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # pQualifierCount : DWORD* out
    Fiddle::TYPE_VOIDP,  # ppQualifiers : IndexedResourceQualifier** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "mrmsupport")]
extern "system" {
    fn IndexFilePath(
        resourceIndexer: *mut (),  // void*
        filePath: *const u16,  // LPCWSTR
        ppResourceUri: *mut *mut u16,  // LPWSTR* out
        pQualifierCount: *mut u32,  // DWORD* out
        ppQualifiers: *mut *mut IndexedResourceQualifier  // IndexedResourceQualifier** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("MrmSupport.dll")]
public static extern int IndexFilePath(IntPtr resourceIndexer, [MarshalAs(UnmanagedType.LPWStr)] string filePath, IntPtr ppResourceUri, out uint pQualifierCount, IntPtr ppQualifiers);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MrmSupport_IndexFilePath' -Namespace Win32 -PassThru
# $api::IndexFilePath(resourceIndexer, filePath, ppResourceUri, pQualifierCount, ppQualifiers)

#uselib "MrmSupport.dll"
#func global IndexFilePath "IndexFilePath" sptr, sptr, sptr, sptr, sptr
; IndexFilePath resourceIndexer, filePath, varptr(ppResourceUri), varptr(pQualifierCount), varptr(ppQualifiers)   ; 戻り値は stat
; resourceIndexer : void* -> "sptr"
; filePath : LPCWSTR -> "sptr"
; ppResourceUri : LPWSTR* out -> "sptr"
; pQualifierCount : DWORD* out -> "sptr"
; ppQualifiers : IndexedResourceQualifier** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MrmSupport.dll"
#cfunc global IndexFilePath "IndexFilePath" sptr, wstr, var, var, var
; res = IndexFilePath(resourceIndexer, filePath, ppResourceUri, pQualifierCount, ppQualifiers)
; resourceIndexer : void* -> "sptr"
; filePath : LPCWSTR -> "wstr"
; ppResourceUri : LPWSTR* out -> "var"
; pQualifierCount : DWORD* out -> "var"
; ppQualifiers : IndexedResourceQualifier** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MrmSupport.dll"
#cfunc global IndexFilePath "IndexFilePath" sptr, wstr, sptr, sptr, sptr
; res = IndexFilePath(resourceIndexer, filePath, varptr(ppResourceUri), varptr(pQualifierCount), varptr(ppQualifiers))
; resourceIndexer : void* -> "sptr"
; filePath : LPCWSTR -> "wstr"
; ppResourceUri : LPWSTR* out -> "sptr"
; pQualifierCount : DWORD* out -> "sptr"
; ppQualifiers : IndexedResourceQualifier** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。