PathCchAppendEx

関数

オプション指定でパス末尾に別のパスを追加する。

DLLapi-ms-win-core-path-l1-1-0.dll呼出規約winapi対応OSwindows8.0

シグネチャ

// api-ms-win-core-path-l1-1-0.dll
#include <windows.h>

HRESULT PathCchAppendEx(
    LPWSTR pszPath,
    UINT_PTR cchPath,
    LPCWSTR pszMore,   // optional
    PATHCCH_OPTIONS dwFlags
);

パラメーター

名前

型

方向

説明

pszPath

LPWSTR

inout

バッファへのポインターです。入力時には元のパスを格納します。この関数が正常に返ると、バッファには元のパスに追加先のパスが連結されたものが格納されます。

cchPath

UINT_PTR

pszPath が指すバッファのサイズ(文字数)です。

pszMore

LPCWSTR

inoptional

pszPath が指すパスの末尾に追加するパスへのポインターです。UNC パスおよび \?\ シーケンスで始まるパスは受け入れられ、完全修飾パスとして認識されます。これらのパスは pszPath が指す文字列に追加されるのではなく、その文字列を置き換えます。

dwFlags

PATHCCH_OPTIONS

次のフラグのうち 1 つ以上です。

値	意味
PATHCCH_NONE 0x0000000	MAX_PATH より長い \\?\ パス(つまりロングパス)の構築を許可しません。
PATHCCH_ALLOW_LONG_PATHS 0x00000001	MAX_PATH より長い \\?\ パスの構築を許可します。
PATHCCH_FORCE_ENABLE_LONG_NAME_PROCESS 0x00000002	プロセスのロングネーム有効状態とは無関係に、呼び出し元をロングパス有効として扱うよう API に強制します。このオプションは PATHCCH_ALLOW_LONG_PATHS が指定されている場合にのみ使用でき、PATHCCH_FORCE_DISABLE_LONG_NAME_PROCESS と併用することはできません。注意この値は Windows 10 バージョン 1703 以降で使用できます。
PATHCCH_FORCE_DISABLE_LONG_NAME_PROCESS 0x00000004	プロセスのロングネーム有効状態とは無関係に、呼び出し元をロングパス無効として扱うよう API に強制します。このオプションは PATHCCH_ALLOW_LONG_PATHS が指定されている場合にのみ使用でき、PATHCCH_FORCE_ENABLE_LONG_NAME_PROCESS と併用することはできません。注意この値は Windows 10 バージョン 1703 以降で使用できます。
PATHCCH_DO_NOT_NORMALIZE_SEGMENTS 0x00000008	末尾のドットおよびスペースの除去を含む、パスセグメントの正規化を無効にします。これにより、win32 のパス正規化によってブロックされるパスへのアクセスが可能になります。注意この値は Windows 10 バージョン 1703 以降で使用できます。
PATHCCH_ENSURE_IS_EXTENDED_LENGTH_PATH 0x00000010	入力パスがまだ拡張長 DOS デバイスパス形式(\\?\ プレフィックス付き)でない場合に、その形式へ変換します。これにより、Win32 の正規化規則(末尾のドットやスペースを除去することがあります)やパス長の制限のために本来アドレス指定できないパスへのアクセスが可能になります。このオプションは PATHCCH_DO_NOT_NORMALIZE_SEGMENTS と同じ動作を含みます。注意この値は Windows 10 バージョン 1703 以降で使用できます。

戻り値の型: HRESULT

公式ドキュメント

あるパスを別のパスの末尾に追加します。この関数は、より長い最終パスを構築できる点で PathCchAppend とは異なります。また、"\"、"\?"、"\?\UNC" プレフィックスを持つパスを受け入れる点で PathAppend とは異なります。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は、次を含む HRESULT コードを返します。

戻り値	説明
E_INVALIDARG	pszPath または pszMore が NULL である、cchPath が 0 である、または cchPath が PATHCCH_MAX_CCH より大きいです。
PATHCCH_E_FILENAME_TOO_LONG	結果の文字列が PATHCCH_MAX_CCH を超えます。
E_OUTOFMEMORY	必要なサイズのバッファを割り当てることができませんでした。

解説(Remarks)

この関数は、まだ存在しない場合、2 つの文字列の間にバックスラッシュを挿入します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// api-ms-win-core-path-l1-1-0.dll
#include <windows.h>

HRESULT PathCchAppendEx(
    LPWSTR pszPath,
    UINT_PTR cchPath,
    LPCWSTR pszMore,   // optional
    PATHCCH_OPTIONS dwFlags
);

[DllImport("api-ms-win-core-path-l1-1-0.dll", ExactSpelling = true)]
static extern int PathCchAppendEx(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath,   // LPWSTR in/out
    UIntPtr cchPath,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszMore,   // LPCWSTR optional
    uint dwFlags   // PATHCCH_OPTIONS
);

<DllImport("api-ms-win-core-path-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function PathCchAppendEx(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As System.Text.StringBuilder,   ' LPWSTR in/out
    cchPath As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPWStr)> pszMore As String,   ' LPCWSTR optional
    dwFlags As UInteger   ' PATHCCH_OPTIONS
) As Integer
End Function

' pszPath : LPWSTR in/out
' cchPath : UINT_PTR
' pszMore : LPCWSTR optional
' dwFlags : PATHCCH_OPTIONS
Declare PtrSafe Function PathCchAppendEx Lib "api-ms-win-core-path-l1-1-0" ( _
    ByVal pszPath As LongPtr, _
    ByVal cchPath As LongPtr, _
    ByVal pszMore As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PathCchAppendEx = ctypes.windll.LoadLibrary("api-ms-win-core-path-l1-1-0.dll").PathCchAppendEx
PathCchAppendEx.restype = ctypes.c_int
PathCchAppendEx.argtypes = [
    wintypes.LPWSTR,  # pszPath : LPWSTR in/out
    ctypes.c_size_t,  # cchPath : UINT_PTR
    wintypes.LPCWSTR,  # pszMore : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : PATHCCH_OPTIONS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-path-l1-1-0.dll')
PathCchAppendEx = Fiddle::Function.new(
  lib['PathCchAppendEx'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPWSTR in/out
    Fiddle::TYPE_UINTPTR_T,  # cchPath : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pszMore : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : PATHCCH_OPTIONS
  ],
  Fiddle::TYPE_INT)

#[link(name = "api-ms-win-core-path-l1-1-0")]
extern "system" {
    fn PathCchAppendEx(
        pszPath: *mut u16,  // LPWSTR in/out
        cchPath: usize,  // UINT_PTR
        pszMore: *const u16,  // LPCWSTR optional
        dwFlags: u32  // PATHCCH_OPTIONS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("api-ms-win-core-path-l1-1-0.dll")]
public static extern int PathCchAppendEx([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath, UIntPtr cchPath, [MarshalAs(UnmanagedType.LPWStr)] string pszMore, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-path-l1-1-0_PathCchAppendEx' -Namespace Win32 -PassThru
# $api::PathCchAppendEx(pszPath, cchPath, pszMore, dwFlags)

#uselib "api-ms-win-core-path-l1-1-0.dll"
#func global PathCchAppendEx "PathCchAppendEx" sptr, sptr, sptr, sptr
; PathCchAppendEx varptr(pszPath), cchPath, pszMore, dwFlags   ; 戻り値は stat
; pszPath : LPWSTR in/out -> "sptr"
; cchPath : UINT_PTR -> "sptr"
; pszMore : LPCWSTR optional -> "sptr"
; dwFlags : PATHCCH_OPTIONS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "api-ms-win-core-path-l1-1-0.dll"
#cfunc global PathCchAppendEx "PathCchAppendEx" var, sptr, wstr, int
; res = PathCchAppendEx(pszPath, cchPath, pszMore, dwFlags)
; pszPath : LPWSTR in/out -> "var"
; cchPath : UINT_PTR -> "sptr"
; pszMore : LPCWSTR optional -> "wstr"
; dwFlags : PATHCCH_OPTIONS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "api-ms-win-core-path-l1-1-0.dll"
#cfunc global PathCchAppendEx "PathCchAppendEx" sptr, sptr, wstr, int
; res = PathCchAppendEx(varptr(pszPath), cchPath, pszMore, dwFlags)
; pszPath : LPWSTR in/out -> "sptr"
; cchPath : UINT_PTR -> "sptr"
; pszMore : LPCWSTR optional -> "wstr"
; dwFlags : PATHCCH_OPTIONS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。