PathCombineW

関数

ディレクトリパスとファイル名を連結し、正規化された1つのパスを生成する。

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

シグネチャ

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

LPWSTR PathCombineW(
    LPWSTR pszDest,
    LPCWSTR pszDir,   // optional
    LPCWSTR pszFile   // optional
);

パラメーター

名前	型	方向	説明
pszDest	LPWSTR	out	この関数が正常に終了したときに、連結後のパス文字列を受け取るバッファーへのポインターです。返される文字列を確実に格納できるよう、このバッファーのサイズは MAX_PATH に設定する必要があります。
pszDir	LPCWSTR	inoptional	最初のパスを格納する、最大長 MAX_PATH の null 終端文字列へのポインターです。この値は NULL でもかまいません。
pszFile	LPCWSTR	inoptional	2 番目のパスを格納する、最大長 MAX_PATH の null 終端文字列へのポインターです。この値は NULL でもかまいません。

戻り値の型: LPWSTR

公式ドキュメント

正しく形成された 2 つのパス文字列を 1 つのパスに連結します。相対パス要素も連結します。(Unicode)

戻り値

型: LPTSTR

この関数が正常に終了したときに、連結後のパス文字列を受け取るバッファーへのポインターです。これは pszPathOut が指す文字列と同じものです。この関数が正常に終了しなかった場合、この値は NULL になります。

解説(Remarks)

ディレクトリパスは A:、B:、...、Z: の形式で指定してください。ファイルパスは、パスのファイル名部分を表す正しい形式である必要があります。ディレクトリパスがバックスラッシュで終わっている場合、そのバックスラッシュは保持されます。lpszDir と lpszFile はどちらも省略可能なパラメーターですが、両方を同時に NULL にすることはできない点に注意してください。

例

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

int main( void )
{
// Buffer to hold combined path.
char buffer_1[MAX_PATH] = "";
char *lpStr1;
lpStr1 = buffer_1;

// String for balance of path name.
char buffer_2[ ] = "One\\Two\\Three";
char *lpStr2;
lpStr2 = buffer_2;

// String for directory name.
char buffer_3[ ] = "C:";
char *lpStr3;
lpStr3 = buffer_3;

cout << "The file path to be combined is  " 
     << lpStr2 << endl;
cout << "The directory name path is       " 
     << lpStr3 << endl;
cout << "The combined path is             " 
     << PathCombine(lpStr1,lpStr3,lpStr2) << endl;
}

------------
INPUT:
------------
Path for directory part: "C:"
Path for file part: "One\Two\Three"
------------
OUTPUT:
------------
The file path to be combined is  One\Two\Three
The directory name path is       C:
The combined path is             C:\One\Two\Three

メモ

shlwapi.h ヘッダーは PathCombine を、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  (Unicode / -W)
#include <windows.h>

LPWSTR PathCombineW(
    LPWSTR pszDest,
    LPCWSTR pszDir,   // optional
    LPCWSTR pszFile   // optional
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr PathCombineW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszDest,   // LPWSTR out
    [MarshalAs(UnmanagedType.LPWStr)] string pszDir,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszFile   // LPCWSTR optional
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathCombineW(
    <MarshalAs(UnmanagedType.LPWStr)> pszDest As System.Text.StringBuilder,   ' LPWSTR out
    <MarshalAs(UnmanagedType.LPWStr)> pszDir As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> pszFile As String   ' LPCWSTR optional
) As IntPtr
End Function

' pszDest : LPWSTR out
' pszDir : LPCWSTR optional
' pszFile : LPCWSTR optional
Declare PtrSafe Function PathCombineW Lib "shlwapi" ( _
    ByVal pszDest As LongPtr, _
    ByVal pszDir As LongPtr, _
    ByVal pszFile As LongPtr) 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

PathCombineW = ctypes.windll.shlwapi.PathCombineW
PathCombineW.restype = wintypes.LPWSTR
PathCombineW.argtypes = [
    wintypes.LPWSTR,  # pszDest : LPWSTR out
    wintypes.LPCWSTR,  # pszDir : LPCWSTR optional
    wintypes.LPCWSTR,  # pszFile : LPCWSTR optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathCombineW = Fiddle::Function.new(
  lib['PathCombineW'],
  [
    Fiddle::TYPE_VOIDP,  # pszDest : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pszDir : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pszFile : LPCWSTR optional
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr PathCombineW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszDest, [MarshalAs(UnmanagedType.LPWStr)] string pszDir, [MarshalAs(UnmanagedType.LPWStr)] string pszFile);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathCombineW' -Namespace Win32 -PassThru
# $api::PathCombineW(pszDest, pszDir, pszFile)

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

出力引数:

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