ホーム › UI.Shell › PathCommonPrefixA

PathCommonPrefixA

関数

2つのパスに共通する先頭部分を求めて取得する。

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

シグネチャ

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

INT PathCommonPrefixA(
    LPCSTR pszFile1,
    LPCSTR pszFile2,
    LPSTR achPath   // optional
);

パラメーター

名前	型	方向	説明
pszFile1	LPCSTR	in	1 つ目のパス名を格納する、長さ MAX_PATH の null 終端文字列へのポインターです。
pszFile2	LPCSTR	in	2 つ目のパス名を格納する、長さ MAX_PATH の null 終端文字列へのポインターです。
achPath	LPSTR	outoptional	共通のプレフィックスを受け取るバッファーへのポインターです。このバッファーのサイズは最低でも MAX_PATH 文字でなければなりません。共通のプレフィックスがない場合は NULL に設定されます。

戻り値の型: INT

公式ドキュメント

2 つのパスを比較して、共通のプレフィックスを持つかどうかを判定します。プレフィックスは次のいずれかの型です: "C:\"、"."、".."、"..\"。(ANSI)

戻り値

型: int

パス内の共通プレフィックス文字数を返します。出力バッファーのポインターが NULL でない場合、これらの文字が出力バッファーにコピーされます。

解説(Remarks)

メモ

shlwapi.h ヘッダーは PathCommonPrefix をエイリアスとして定義しており、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>

INT PathCommonPrefixA(
    LPCSTR pszFile1,
    LPCSTR pszFile2,
    LPSTR achPath   // optional
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int PathCommonPrefixA(
    [MarshalAs(UnmanagedType.LPStr)] string pszFile1,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pszFile2,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder achPath   // LPSTR optional, out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathCommonPrefixA(
    <MarshalAs(UnmanagedType.LPStr)> pszFile1 As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszFile2 As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> achPath As System.Text.StringBuilder   ' LPSTR optional, out
) As Integer
End Function

' pszFile1 : LPCSTR
' pszFile2 : LPCSTR
' achPath : LPSTR optional, out
Declare PtrSafe Function PathCommonPrefixA Lib "shlwapi" ( _
    ByVal pszFile1 As String, _
    ByVal pszFile2 As String, _
    ByVal achPath As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PathCommonPrefixA = ctypes.windll.shlwapi.PathCommonPrefixA
PathCommonPrefixA.restype = ctypes.c_int
PathCommonPrefixA.argtypes = [
    wintypes.LPCSTR,  # pszFile1 : LPCSTR
    wintypes.LPCSTR,  # pszFile2 : LPCSTR
    wintypes.LPSTR,  # achPath : LPSTR optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathCommonPrefixA = Fiddle::Function.new(
  lib['PathCommonPrefixA'],
  [
    Fiddle::TYPE_VOIDP,  # pszFile1 : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszFile2 : LPCSTR
    Fiddle::TYPE_VOIDP,  # achPath : LPSTR optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn PathCommonPrefixA(
        pszFile1: *const u8,  // LPCSTR
        pszFile2: *const u8,  // LPCSTR
        achPath: *mut u8  // LPSTR optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int PathCommonPrefixA([MarshalAs(UnmanagedType.LPStr)] string pszFile1, [MarshalAs(UnmanagedType.LPStr)] string pszFile2, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder achPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathCommonPrefixA' -Namespace Win32 -PassThru
# $api::PathCommonPrefixA(pszFile1, pszFile2, achPath)

#uselib "SHLWAPI.dll"
#func global PathCommonPrefixA "PathCommonPrefixA" sptr, sptr, sptr
; PathCommonPrefixA pszFile1, pszFile2, varptr(achPath)   ; 戻り値は stat
; pszFile1 : LPCSTR -> "sptr"
; pszFile2 : LPCSTR -> "sptr"
; achPath : LPSTR optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global PathCommonPrefixA "PathCommonPrefixA" str, str, var
; res = PathCommonPrefixA(pszFile1, pszFile2, achPath)
; pszFile1 : LPCSTR -> "str"
; pszFile2 : LPCSTR -> "str"
; achPath : LPSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global PathCommonPrefixA "PathCommonPrefixA" str, str, sptr
; res = PathCommonPrefixA(pszFile1, pszFile2, varptr(achPath))
; pszFile1 : LPCSTR -> "str"
; pszFile2 : LPCSTR -> "str"
; achPath : LPSTR optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。