ホーム › UI.Shell › PathRelativePathToW

PathRelativePathToW

関数

ある場所から別の場所への相対パスを生成する。

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

シグネチャ

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

BOOL PathRelativePathToW(
    LPWSTR pszPath,
    LPCWSTR pszFrom,
    DWORD dwAttrFrom,
    LPCWSTR pszTo,
    DWORD dwAttrTo
);

パラメーター

名前	型	方向	説明
pszPath	LPWSTR	out	相対パスを受け取る文字列へのポインター。このバッファーは少なくとも MAX_PATH 文字分のサイズが必要です。
pszFrom	LPCWSTR	in	相対パスの起点を定義するパスを格納した、最大長 MAX_PATH の null 終端文字列へのポインター。
dwAttrFrom	DWORD	in	pszFrom のファイル属性。この値に FILE_ATTRIBUTE_DIRECTORY が含まれている場合、pszFrom はディレクトリと見なされます。それ以外の場合、pszFrom はファイルと見なされます。
pszTo	LPCWSTR	in	相対パスの終点を定義するパスを格納した、最大長 MAX_PATH の null 終端文字列へのポインター。
dwAttrTo	DWORD	in	pszTo のファイル属性。この値に FILE_ATTRIBUTE_DIRECTORY が含まれている場合、pszTo はディレクトリと見なされます。それ以外の場合、pszTo はファイルと見なされます。

戻り値の型: BOOL

公式ドキュメント

あるファイルまたはフォルダーから別のファイルまたはフォルダーへの相対パスを作成します。(Unicode)

戻り値

型: BOOL

成功した場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

この関数は 1 組のパスを受け取り、一方から他方への相対パスを生成します。パスは完全修飾されている必要はありませんが、共通の接頭辞を持っている必要があります。持っていない場合、この関数は失敗して FALSE を返します。

たとえば、起点 pszFrom を "c:\FolderA\FolderB\FolderC"、終点 pszTo を "c:\FolderA\FolderD\FolderE" とします。PathRelativePathTo は pszFrom から pszTo への相対パスとして "....\FolderD\FolderE" を返します。pszFrom を "\FolderA\FolderB\FolderC"、pszTo を "\FolderA\FolderD\FolderE" に設定した場合も同じ結果になります。一方、"c:\FolderA\FolderB" と "a:\FolderA\FolderD" は共通の接頭辞を持たないため、この関数は失敗します。なお、"\" は接頭辞とは見なされず、無視されます。pszFrom を "\FolderA\FolderB"、pszTo を "\FolderC\FolderD" に設定した場合、この関数は失敗します。

例

#include <windows.h>
#include <iostream.h>
#include "Shlwapi.h"

void main(void)
{
    char szOut[MAX_PATH] = "";
    char szFrom[ ] = "c:\\a\\b\\path";
    char szTo[ ] = "c:\\a\\x\\y\\file";

    cout  <<  "The relative path is relative from: ";
    cout  <<  szFrom;
    cout  <<  "\n";

    cout  <<  "The relative path is relative to: ";
    cout  <<  szTo;
    cout  <<  "\n";

    PathRelativePathTo(szOut,
                       szFrom,
                       FILE_ATTRIBUTE_DIRECTORY,
                       szTo,
                       FILE_ATTRIBUTE_NORMAL);

    cout  <<  "The relative path is: ";
    cout  <<  szOut;
    cout  <<  "\n";
}

OUTPUT:
==================
The relative path is relative from: c:\a\b\path
The relative path is relative to: c:\a\x\y\file
The relative path is: ..\..\x\y\file

メモ

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

BOOL PathRelativePathToW(
    LPWSTR pszPath,
    LPCWSTR pszFrom,
    DWORD dwAttrFrom,
    LPCWSTR pszTo,
    DWORD dwAttrTo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool PathRelativePathToW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath,   // LPWSTR out
    [MarshalAs(UnmanagedType.LPWStr)] string pszFrom,   // LPCWSTR
    uint dwAttrFrom,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pszTo,   // LPCWSTR
    uint dwAttrTo   // DWORD
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathRelativePathToW(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As System.Text.StringBuilder,   ' LPWSTR out
    <MarshalAs(UnmanagedType.LPWStr)> pszFrom As String,   ' LPCWSTR
    dwAttrFrom As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pszTo As String,   ' LPCWSTR
    dwAttrTo As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pszPath : LPWSTR out
' pszFrom : LPCWSTR
' dwAttrFrom : DWORD
' pszTo : LPCWSTR
' dwAttrTo : DWORD
Declare PtrSafe Function PathRelativePathToW Lib "shlwapi" ( _
    ByVal pszPath As LongPtr, _
    ByVal pszFrom As LongPtr, _
    ByVal dwAttrFrom As Long, _
    ByVal pszTo As LongPtr, _
    ByVal dwAttrTo As Long) 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

PathRelativePathToW = ctypes.windll.shlwapi.PathRelativePathToW
PathRelativePathToW.restype = wintypes.BOOL
PathRelativePathToW.argtypes = [
    wintypes.LPWSTR,  # pszPath : LPWSTR out
    wintypes.LPCWSTR,  # pszFrom : LPCWSTR
    wintypes.DWORD,  # dwAttrFrom : DWORD
    wintypes.LPCWSTR,  # pszTo : LPCWSTR
    wintypes.DWORD,  # dwAttrTo : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathRelativePathToW = Fiddle::Function.new(
  lib['PathRelativePathToW'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pszFrom : LPCWSTR
    -Fiddle::TYPE_INT,  # dwAttrFrom : DWORD
    Fiddle::TYPE_VOIDP,  # pszTo : LPCWSTR
    -Fiddle::TYPE_INT,  # dwAttrTo : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shlwapi")]
extern "system" {
    fn PathRelativePathToW(
        pszPath: *mut u16,  // LPWSTR out
        pszFrom: *const u16,  // LPCWSTR
        dwAttrFrom: u32,  // DWORD
        pszTo: *const u16,  // LPCWSTR
        dwAttrTo: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern bool PathRelativePathToW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath, [MarshalAs(UnmanagedType.LPWStr)] string pszFrom, uint dwAttrFrom, [MarshalAs(UnmanagedType.LPWStr)] string pszTo, uint dwAttrTo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathRelativePathToW' -Namespace Win32 -PassThru
# $api::PathRelativePathToW(pszPath, pszFrom, dwAttrFrom, pszTo, dwAttrTo)

#uselib "SHLWAPI.dll"
#func global PathRelativePathToW "PathRelativePathToW" wptr, wptr, wptr, wptr, wptr
; PathRelativePathToW varptr(pszPath), pszFrom, dwAttrFrom, pszTo, dwAttrTo   ; 戻り値は stat
; pszPath : LPWSTR out -> "wptr"
; pszFrom : LPCWSTR -> "wptr"
; dwAttrFrom : DWORD -> "wptr"
; pszTo : LPCWSTR -> "wptr"
; dwAttrTo : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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