Win32 API 日本語リファレンス
ホームUI.Shell › PathAddBackslashW

PathAddBackslashW

関数
パス末尾に円記号区切りを追加する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

LPWSTR PathAddBackslashW(
    LPWSTR pszPath
);

パラメーター

名前方向説明
pszPathLPWSTRinoutパスを表す文字列が格納されたバッファーへのポインター。返される文字列を保持するのに十分な大きさを確保するため、このバッファーのサイズは MAX_PATH に設定する必要があります。

戻り値の型: LPWSTR

公式ドキュメント

パスとして正しい構文にするため、文字列の末尾にバックスラッシュを追加します。(PathAddBackslashW)

戻り値

型: LPTSTR

この関数が正常に終了した場合に、新しい文字列の終端 null 文字を指すポインター。バッファーサイズが不足してバックスラッシュを追加できなかった場合、この値は NULL になります。

解説(Remarks)

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいて、この関数の ANSI バージョンまたは Unicode バージョンを自動的に選択するエイリアスとして PathAddBackslash を定義しています。このエンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PathAddBackslashW(
    LPWSTR pszPath
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr PathAddBackslashW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath   // LPWSTR in/out
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathAddBackslashW(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As System.Text.StringBuilder   ' LPWSTR in/out
) As IntPtr
End Function
' pszPath : LPWSTR in/out
Declare PtrSafe Function PathAddBackslashW Lib "shlwapi" ( _
    ByVal pszPath 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

PathAddBackslashW = ctypes.windll.shlwapi.PathAddBackslashW
PathAddBackslashW.restype = wintypes.LPWSTR
PathAddBackslashW.argtypes = [
    wintypes.LPWSTR,  # pszPath : LPWSTR in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathAddBackslashW = Fiddle::Function.new(
  lib['PathAddBackslashW'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPWSTR in/out
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn PathAddBackslashW(
        pszPath: *mut u16  // LPWSTR in/out
    ) -> *mut u16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr PathAddBackslashW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathAddBackslashW' -Namespace Win32 -PassThru
# $api::PathAddBackslashW(pszPath)
#uselib "SHLWAPI.dll"
#func global PathAddBackslashW "PathAddBackslashW" wptr
; PathAddBackslashW varptr(pszPath)   ; 戻り値は stat
; pszPath : LPWSTR in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global PathAddBackslashW "PathAddBackslashW" var
; res = PathAddBackslashW(pszPath)
; pszPath : LPWSTR in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; LPWSTR PathAddBackslashW(LPWSTR pszPath)
#uselib "SHLWAPI.dll"
#cfunc global PathAddBackslashW "PathAddBackslashW" var
; res = PathAddBackslashW(pszPath)
; pszPath : LPWSTR in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathAddBackslashW = shlwapi.NewProc("PathAddBackslashW")
)

// pszPath (LPWSTR in/out)
r1, _, err := procPathAddBackslashW.Call(
	uintptr(pszPath),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LPWSTR
function PathAddBackslashW(
  pszPath: PWideChar   // LPWSTR in/out
): PWideChar; stdcall;
  external 'SHLWAPI.dll' name 'PathAddBackslashW';
result := DllCall("SHLWAPI\PathAddBackslashW"
    , "Ptr", pszPath   ; LPWSTR in/out
    , "Ptr")   ; return: LPWSTR
●PathAddBackslashW(pszPath) = DLL("SHLWAPI.dll", "char* PathAddBackslashW(char*)")
# 呼び出し: PathAddBackslashW(pszPath)
# pszPath : LPWSTR in/out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn PathAddBackslashW(
    pszPath: [*c]u16 // LPWSTR in/out
) callconv(std.os.windows.WINAPI) [*c]const u16;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc PathAddBackslashW(
    pszPath: ptr uint16  # LPWSTR in/out
): WideCString {.importc: "PathAddBackslashW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
const(wchar)* PathAddBackslashW(
    wchar* pszPath   // LPWSTR in/out
);
ccall((:PathAddBackslashW, "SHLWAPI.dll"), stdcall, Cwstring,
      (Ptr{UInt16},),
      pszPath)
# pszPath : LPWSTR in/out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
const uint16_t* PathAddBackslashW(
    uint16_t* pszPath);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathAddBackslashW(pszPath)
-- pszPath : LPWSTR in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathAddBackslashW = lib.func('__stdcall', 'PathAddBackslashW', 'void *', ['uint16_t *']);
// PathAddBackslashW(pszPath)
// pszPath : LPWSTR in/out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  PathAddBackslashW: { parameters: ["buffer"], result: "pointer" },
});
// lib.symbols.PathAddBackslashW(pszPath)
// pszPath : LPWSTR in/out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
const uint16_t* PathAddBackslashW(
    uint16_t* pszPath);
C, "SHLWAPI.dll");
// $ffi->PathAddBackslashW(pszPath);
// pszPath : LPWSTR in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    Pointer PathAddBackslashW(
        char[] pszPath   // LPWSTR in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun PathAddBackslashW = PathAddBackslashW(
    pszPath : UInt16*   # LPWSTR in/out
  ) : UInt16*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PathAddBackslashWNative = Pointer<Utf16> Function(Pointer<Utf16>);
typedef PathAddBackslashWDart = Pointer<Utf16> Function(Pointer<Utf16>);
final PathAddBackslashW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<PathAddBackslashWNative, PathAddBackslashWDart>('PathAddBackslashW');
// pszPath : LPWSTR in/out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PathAddBackslashW(
  pszPath: PWideChar   // LPWSTR in/out
): PWideChar; stdcall;
  external 'SHLWAPI.dll' name 'PathAddBackslashW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PathAddBackslashW"
  c_PathAddBackslashW :: CWString -> IO CWString
-- pszPath : LPWSTR in/out -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pathaddbackslashw =
  foreign "PathAddBackslashW"
    ((ptr uint16_t) @-> returning (ptr uint16_t))
(* pszPath : LPWSTR in/out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("PathAddBackslashW" path-add-backslash-w :convention :stdcall) (:string :encoding :utf-16le)
  (psz-path :pointer))   ; LPWSTR in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathAddBackslashW = Win32::API::More->new('SHLWAPI',
    'LPWSTR PathAddBackslashW(LPWSTR pszPath)');
# my $ret = $PathAddBackslashW->Call($pszPath);
# pszPath : LPWSTR in/out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い