ホーム › UI.Shell › PathCommonPrefixW

PathCommonPrefixW

関数

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

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

シグネチャ

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

INT PathCommonPrefixW(
    LPCWSTR pszFile1,
    LPCWSTR pszFile2,
    LPWSTR achPath   // optional
);

パラメーター

名前	型	方向	説明
pszFile1	LPCWSTR	in	1 つ目のパス名を格納した、長さ MAX_PATH の null 終端文字列へのポインターです。
pszFile2	LPCWSTR	in	2 つ目のパス名を格納した、長さ MAX_PATH の null 終端文字列へのポインターです。
achPath	LPWSTR	outoptional	共通のプレフィックスを受け取るバッファーへのポインターです。このバッファーのサイズは少なくとも MAX_PATH 文字分必要です。共通のプレフィックスが存在しない場合は NULL が設定されます。

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

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

解説(Remarks)

メモ

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

INT PathCommonPrefixW(
    LPCWSTR pszFile1,
    LPCWSTR pszFile2,
    LPWSTR achPath   // optional
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int PathCommonPrefixW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszFile1,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszFile2,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder achPath   // LPWSTR optional, out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathCommonPrefixW(
    <MarshalAs(UnmanagedType.LPWStr)> pszFile1 As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszFile2 As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> achPath As System.Text.StringBuilder   ' LPWSTR optional, out
) As Integer
End Function

' pszFile1 : LPCWSTR
' pszFile2 : LPCWSTR
' achPath : LPWSTR optional, out
Declare PtrSafe Function PathCommonPrefixW Lib "shlwapi" ( _
    ByVal pszFile1 As LongPtr, _
    ByVal pszFile2 As LongPtr, _
    ByVal achPath As LongPtr) As Long
' 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

PathCommonPrefixW = ctypes.windll.shlwapi.PathCommonPrefixW
PathCommonPrefixW.restype = ctypes.c_int
PathCommonPrefixW.argtypes = [
    wintypes.LPCWSTR,  # pszFile1 : LPCWSTR
    wintypes.LPCWSTR,  # pszFile2 : LPCWSTR
    wintypes.LPWSTR,  # achPath : LPWSTR optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathCommonPrefixW = Fiddle::Function.new(
  lib['PathCommonPrefixW'],
  [
    Fiddle::TYPE_VOIDP,  # pszFile1 : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszFile2 : LPCWSTR
    Fiddle::TYPE_VOIDP,  # achPath : LPWSTR optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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