ホーム › UI.Shell › PathFindSuffixArrayA

PathFindSuffixArrayA

関数

指定した接尾辞配列のいずれかにパスが一致するか調べる。

DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

LPSTR PathFindSuffixArrayA(
    LPCSTR pszPath,
    LPCSTR* apszSuffix,
    INT iArraySize
);

パラメーター

名前	型	方向	説明
pszPath	LPCSTR	in	テスト対象のファイル名を含む、最大長 MAX_PATH の null 終端文字列へのポインターです。フルパスを使用できます。
apszSuffix	LPCSTR*	in	iArraySize 個の文字列ポインターからなる配列です。各文字列は null 終端で、1 つのサフィックスを含みます。各文字列の長さは異なっていてもかまいません。
iArraySize	INT	in	apszSuffix が指す配列の要素数です。

戻り値の型: LPSTR

公式ドキュメント

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

戻り値

型: LPCTSTR

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

解説(Remarks)

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

メモ

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

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

各言語での呼び出し定義

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

LPSTR PathFindSuffixArrayA(
    LPCSTR pszPath,
    LPCSTR* apszSuffix,
    INT iArraySize
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr PathFindSuffixArrayA(
    [MarshalAs(UnmanagedType.LPStr)] string pszPath,   // LPCSTR
    IntPtr apszSuffix,   // LPCSTR*
    int iArraySize   // INT
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathFindSuffixArrayA(
    <MarshalAs(UnmanagedType.LPStr)> pszPath As String,   ' LPCSTR
    apszSuffix As IntPtr,   ' LPCSTR*
    iArraySize As Integer   ' INT
) As IntPtr
End Function

' pszPath : LPCSTR
' apszSuffix : LPCSTR*
' iArraySize : INT
Declare PtrSafe Function PathFindSuffixArrayA Lib "shlwapi" ( _
    ByVal pszPath As String, _
    ByVal apszSuffix As LongPtr, _
    ByVal iArraySize As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PathFindSuffixArrayA = ctypes.windll.shlwapi.PathFindSuffixArrayA
PathFindSuffixArrayA.restype = wintypes.LPSTR
PathFindSuffixArrayA.argtypes = [
    wintypes.LPCSTR,  # pszPath : LPCSTR
    ctypes.c_void_p,  # apszSuffix : LPCSTR*
    ctypes.c_int,  # iArraySize : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathFindSuffixArrayA = Fiddle::Function.new(
  lib['PathFindSuffixArrayA'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCSTR
    Fiddle::TYPE_VOIDP,  # apszSuffix : LPCSTR*
    Fiddle::TYPE_INT,  # iArraySize : INT
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "shlwapi")]
extern "system" {
    fn PathFindSuffixArrayA(
        pszPath: *const u8,  // LPCSTR
        apszSuffix: *const *const u8,  // LPCSTR*
        iArraySize: i32  // INT
    ) -> *mut u8;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr PathFindSuffixArrayA([MarshalAs(UnmanagedType.LPStr)] string pszPath, IntPtr apszSuffix, int iArraySize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathFindSuffixArrayA' -Namespace Win32 -PassThru
# $api::PathFindSuffixArrayA(pszPath, apszSuffix, iArraySize)

#uselib "SHLWAPI.dll"
#func global PathFindSuffixArrayA "PathFindSuffixArrayA" sptr, sptr, sptr
; PathFindSuffixArrayA pszPath, varptr(apszSuffix), iArraySize   ; 戻り値は stat
; pszPath : LPCSTR -> "sptr"
; apszSuffix : LPCSTR* -> "sptr"
; iArraySize : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global PathFindSuffixArrayA "PathFindSuffixArrayA" str, var, int
; res = PathFindSuffixArrayA(pszPath, apszSuffix, iArraySize)
; pszPath : LPCSTR -> "str"
; apszSuffix : LPCSTR* -> "var"
; iArraySize : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global PathFindSuffixArrayA "PathFindSuffixArrayA" str, sptr, int
; res = PathFindSuffixArrayA(pszPath, varptr(apszSuffix), iArraySize)
; pszPath : LPCSTR -> "str"
; apszSuffix : LPCSTR* -> "sptr"
; iArraySize : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。