PathCombineA

関数

ディレクトリとファイル名を結合して完全なパスを作る。

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

シグネチャ

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

LPSTR PathCombineA(
    LPSTR pszDest,
    LPCSTR pszDir,   // optional
    LPCSTR pszFile   // optional
);

パラメーター

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

戻り値の型: LPSTR

公式ドキュメント

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

戻り値

型: LPTSTR

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

解説(Remarks)

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

例

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

void 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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PathCombine を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不整合が生じてコンパイルエラーやランタイムエラーの原因となることがあります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PathCombineA(
    LPSTR pszDest,
    LPCSTR pszDir,   // optional
    LPCSTR pszFile   // optional
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr PathCombineA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszDest,   // LPSTR out
    [MarshalAs(UnmanagedType.LPStr)] string pszDir,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string pszFile   // LPCSTR optional
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathCombineA(
    <MarshalAs(UnmanagedType.LPStr)> pszDest As System.Text.StringBuilder,   ' LPSTR out
    <MarshalAs(UnmanagedType.LPStr)> pszDir As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> pszFile As String   ' LPCSTR optional
) As IntPtr
End Function

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

import ctypes
from ctypes import wintypes

PathCombineA = ctypes.windll.shlwapi.PathCombineA
PathCombineA.restype = wintypes.LPSTR
PathCombineA.argtypes = [
    wintypes.LPSTR,  # pszDest : LPSTR out
    wintypes.LPCSTR,  # pszDir : LPCSTR optional
    wintypes.LPCSTR,  # pszFile : LPCSTR optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathCombineA = Fiddle::Function.new(
  lib['PathCombineA'],
  [
    Fiddle::TYPE_VOIDP,  # pszDest : LPSTR out
    Fiddle::TYPE_VOIDP,  # pszDir : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pszFile : LPCSTR optional
  ],
  Fiddle::TYPE_VOIDP)

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

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

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

出力引数:

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