Win32 API 日本語リファレンス
ホームUI.Shell › PathFindSuffixArrayW

PathFindSuffixArrayW

関数
指定した接尾辞配列のいずれかにパスが一致するか調べる。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

LPWSTR PathFindSuffixArrayW(
    LPCWSTR pszPath,
    LPCWSTR* apszSuffix,
    INT iArraySize
);

パラメーター

名前方向説明
pszPathLPCWSTRinテスト対象のファイル名を含む、最大長 MAX_PATH の null 終端文字列へのポインターです。フルパスを使用できます。
apszSuffixLPCWSTR*iniArraySize 個の文字列ポインターの配列です。指し示される各文字列は null 終端で、1 つのサフィックスを含みます。文字列の長さは可変です。
iArraySizeINTinapszSuffix が指す配列内の要素数です。

戻り値の型: LPWSTR

公式ドキュメント

指定されたファイル名が、サフィックスのリストのいずれかを持つかどうかを判定します。(Unicode)

戻り値

型: LPCTSTR

成功した場合は一致するサフィックスを持つ文字列へのポインターを返します。pszPath が指定されたサフィックスのいずれでも終わらない場合は NULL を返します。

解説(Remarks)

この関数は大文字と小文字を区別する比較を行います。サフィックスは正確に一致する必要があります。

メモ

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

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

各言語での呼び出し定義

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

LPWSTR PathFindSuffixArrayW(
    LPCWSTR pszPath,
    LPCWSTR* apszSuffix,
    INT iArraySize
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr PathFindSuffixArrayW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath,   // LPCWSTR
    IntPtr apszSuffix,   // LPCWSTR*
    int iArraySize   // INT
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathFindSuffixArrayW(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String,   ' LPCWSTR
    apszSuffix As IntPtr,   ' LPCWSTR*
    iArraySize As Integer   ' INT
) As IntPtr
End Function
' pszPath : LPCWSTR
' apszSuffix : LPCWSTR*
' iArraySize : INT
Declare PtrSafe Function PathFindSuffixArrayW Lib "shlwapi" ( _
    ByVal pszPath As LongPtr, _
    ByVal apszSuffix As LongPtr, _
    ByVal iArraySize As Long) As LongPtr
' 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

PathFindSuffixArrayW = ctypes.windll.shlwapi.PathFindSuffixArrayW
PathFindSuffixArrayW.restype = wintypes.LPWSTR
PathFindSuffixArrayW.argtypes = [
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
    ctypes.c_void_p,  # apszSuffix : LPCWSTR*
    ctypes.c_int,  # iArraySize : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathFindSuffixArrayW = Fiddle::Function.new(
  lib['PathFindSuffixArrayW'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # apszSuffix : LPCWSTR*
    Fiddle::TYPE_INT,  # iArraySize : INT
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn PathFindSuffixArrayW(
        pszPath: *const u16,  // LPCWSTR
        apszSuffix: *const *const u16,  // LPCWSTR*
        iArraySize: i32  // INT
    ) -> *mut u16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr PathFindSuffixArrayW([MarshalAs(UnmanagedType.LPWStr)] string pszPath, IntPtr apszSuffix, int iArraySize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathFindSuffixArrayW' -Namespace Win32 -PassThru
# $api::PathFindSuffixArrayW(pszPath, apszSuffix, iArraySize)
#uselib "SHLWAPI.dll"
#func global PathFindSuffixArrayW "PathFindSuffixArrayW" wptr, wptr, wptr
; PathFindSuffixArrayW pszPath, varptr(apszSuffix), iArraySize   ; 戻り値は stat
; pszPath : LPCWSTR -> "wptr"
; apszSuffix : LPCWSTR* -> "wptr"
; iArraySize : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global PathFindSuffixArrayW "PathFindSuffixArrayW" wstr, var, int
; res = PathFindSuffixArrayW(pszPath, apszSuffix, iArraySize)
; pszPath : LPCWSTR -> "wstr"
; apszSuffix : LPCWSTR* -> "var"
; iArraySize : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; LPWSTR PathFindSuffixArrayW(LPCWSTR pszPath, LPCWSTR* apszSuffix, INT iArraySize)
#uselib "SHLWAPI.dll"
#cfunc global PathFindSuffixArrayW "PathFindSuffixArrayW" wstr, var, int
; res = PathFindSuffixArrayW(pszPath, apszSuffix, iArraySize)
; pszPath : LPCWSTR -> "wstr"
; apszSuffix : LPCWSTR* -> "var"
; iArraySize : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathFindSuffixArrayW = shlwapi.NewProc("PathFindSuffixArrayW")
)

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

extern "shlwapi" fn PathFindSuffixArrayW(
    pszPath: [*c]const u16, // LPCWSTR
    apszSuffix: [*c][*c]u16, // LPCWSTR*
    iArraySize: i32 // INT
) callconv(std.os.windows.WINAPI) [*c]const u16;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc PathFindSuffixArrayW(
    pszPath: WideCString,  # LPCWSTR
    apszSuffix: ptr WideCString,  # LPCWSTR*
    iArraySize: int32  # INT
): WideCString {.importc: "PathFindSuffixArrayW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
const(wchar)* PathFindSuffixArrayW(
    const(wchar)* pszPath,   // LPCWSTR
    wchar** apszSuffix,   // LPCWSTR*
    int iArraySize   // INT
);
ccall((:PathFindSuffixArrayW, "SHLWAPI.dll"), stdcall, Cwstring,
      (Cwstring, Ptr{Ptr{UInt16}}, Int32),
      pszPath, apszSuffix, iArraySize)
# pszPath : LPCWSTR -> Cwstring
# apszSuffix : LPCWSTR* -> Ptr{Ptr{UInt16}}
# iArraySize : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
const uint16_t* PathFindSuffixArrayW(
    const uint16_t* pszPath,
    uint16_t** apszSuffix,
    int32_t iArraySize);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathFindSuffixArrayW(pszPath, apszSuffix, iArraySize)
-- pszPath : LPCWSTR
-- apszSuffix : LPCWSTR*
-- iArraySize : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathFindSuffixArrayW = lib.func('__stdcall', 'PathFindSuffixArrayW', 'void *', ['str16', 'void *', 'int32_t']);
// PathFindSuffixArrayW(pszPath, apszSuffix, iArraySize)
// pszPath : LPCWSTR -> 'str16'
// apszSuffix : LPCWSTR* -> 'void *'
// iArraySize : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  PathFindSuffixArrayW: { parameters: ["buffer", "pointer", "i32"], result: "pointer" },
});
// lib.symbols.PathFindSuffixArrayW(pszPath, apszSuffix, iArraySize)
// pszPath : LPCWSTR -> "buffer"
// apszSuffix : LPCWSTR* -> "pointer"
// iArraySize : INT -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
const uint16_t* PathFindSuffixArrayW(
    const uint16_t* pszPath,
    uint16_t** apszSuffix,
    int32_t iArraySize);
C, "SHLWAPI.dll");
// $ffi->PathFindSuffixArrayW(pszPath, apszSuffix, iArraySize);
// pszPath : LPCWSTR
// apszSuffix : LPCWSTR*
// iArraySize : INT
// 構造体/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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    Pointer PathFindSuffixArrayW(
        WString pszPath,   // LPCWSTR
        PointerByReference apszSuffix,   // LPCWSTR*
        int iArraySize   // INT
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun PathFindSuffixArrayW = PathFindSuffixArrayW(
    pszPath : UInt16*,   # LPCWSTR
    apszSuffix : UInt16**,   # LPCWSTR*
    iArraySize : Int32   # INT
  ) : UInt16*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PathFindSuffixArrayWNative = Pointer<Utf16> Function(Pointer<Utf16>, Pointer<Pointer<Utf16>>, Int32);
typedef PathFindSuffixArrayWDart = Pointer<Utf16> Function(Pointer<Utf16>, Pointer<Pointer<Utf16>>, int);
final PathFindSuffixArrayW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<PathFindSuffixArrayWNative, PathFindSuffixArrayWDart>('PathFindSuffixArrayW');
// pszPath : LPCWSTR -> Pointer<Utf16>
// apszSuffix : LPCWSTR* -> Pointer<Pointer<Utf16>>
// iArraySize : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PathFindSuffixArrayW(
  pszPath: PWideChar;   // LPCWSTR
  apszSuffix: PPWideChar;   // LPCWSTR*
  iArraySize: Integer   // INT
): PWideChar; stdcall;
  external 'SHLWAPI.dll' name 'PathFindSuffixArrayW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PathFindSuffixArrayW"
  c_PathFindSuffixArrayW :: CWString -> Ptr CWString -> Int32 -> IO CWString
-- pszPath : LPCWSTR -> CWString
-- apszSuffix : LPCWSTR* -> Ptr CWString
-- iArraySize : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pathfindsuffixarrayw =
  foreign "PathFindSuffixArrayW"
    ((ptr uint16_t) @-> (ptr (ptr uint16_t)) @-> int32_t @-> returning (ptr uint16_t))
(* pszPath : LPCWSTR -> (ptr uint16_t) *)
(* apszSuffix : LPCWSTR* -> (ptr (ptr uint16_t)) *)
(* iArraySize : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("PathFindSuffixArrayW" path-find-suffix-array-w :convention :stdcall) (:string :encoding :utf-16le)
  (psz-path (:string :encoding :utf-16le))   ; LPCWSTR
  (apsz-suffix :pointer)   ; LPCWSTR*
  (i-array-size :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathFindSuffixArrayW = Win32::API::More->new('SHLWAPI',
    'LPWSTR PathFindSuffixArrayW(LPCWSTR pszPath, LPVOID apszSuffix, int iArraySize)');
# my $ret = $PathFindSuffixArrayW->Call($pszPath, $apszSuffix, $iArraySize);
# pszPath : LPCWSTR -> LPCWSTR
# apszSuffix : LPCWSTR* -> LPVOID
# iArraySize : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い