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

PathAddBackslashA

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

シグネチャ

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

LPSTR PathAddBackslashA(
    LPSTR pszPath
);

パラメーター

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

戻り値の型: LPSTR

公式ドキュメント

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

戻り値

型: LPTSTR

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

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PathAddBackslashA(
    LPSTR pszPath
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr PathAddBackslashA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath   // LPSTR in/out
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathAddBackslashA(
    <MarshalAs(UnmanagedType.LPStr)> pszPath As System.Text.StringBuilder   ' LPSTR in/out
) As IntPtr
End Function
' pszPath : LPSTR in/out
Declare PtrSafe Function PathAddBackslashA Lib "shlwapi" ( _
    ByVal pszPath As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathAddBackslashA = shlwapi.NewProc("PathAddBackslashA")
)

// pszPath (LPSTR in/out)
r1, _, err := procPathAddBackslashA.Call(
	uintptr(pszPath),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LPSTR
function PathAddBackslashA(
  pszPath: PAnsiChar   // LPSTR in/out
): PAnsiChar; stdcall;
  external 'SHLWAPI.dll' name 'PathAddBackslashA';
result := DllCall("SHLWAPI\PathAddBackslashA"
    , "Ptr", pszPath   ; LPSTR in/out
    , "Ptr")   ; return: LPSTR
●PathAddBackslashA(pszPath) = DLL("SHLWAPI.dll", "char* PathAddBackslashA(char*)")
# 呼び出し: PathAddBackslashA(pszPath)
# pszPath : LPSTR in/out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn PathAddBackslashA(
    pszPath: [*c]u8 // LPSTR in/out
) callconv(std.os.windows.WINAPI) [*c]const u8;
proc PathAddBackslashA(
    pszPath: ptr char  # LPSTR in/out
): cstring {.importc: "PathAddBackslashA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
const(char)* PathAddBackslashA(
    char* pszPath   // LPSTR in/out
);
ccall((:PathAddBackslashA, "SHLWAPI.dll"), stdcall, Cstring,
      (Ptr{UInt8},),
      pszPath)
# pszPath : LPSTR in/out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
const char* PathAddBackslashA(
    char* pszPath);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathAddBackslashA(pszPath)
-- pszPath : LPSTR in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathAddBackslashA = lib.func('__stdcall', 'PathAddBackslashA', 'void *', ['char *']);
// PathAddBackslashA(pszPath)
// pszPath : LPSTR in/out -> 'char *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  PathAddBackslashA: { parameters: ["buffer"], result: "pointer" },
});
// lib.symbols.PathAddBackslashA(pszPath)
// pszPath : LPSTR in/out -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
const char* PathAddBackslashA(
    char* pszPath);
C, "SHLWAPI.dll");
// $ffi->PathAddBackslashA(pszPath);
// pszPath : LPSTR 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.ASCII_OPTIONS);
    Pointer PathAddBackslashA(
        byte[] pszPath   // LPSTR in/out
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun PathAddBackslashA = PathAddBackslashA(
    pszPath : UInt8*   # LPSTR in/out
  ) : UInt8*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("PathAddBackslashA" path-add-backslash-a :convention :stdcall) :string
  (psz-path :pointer))   ; LPSTR in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathAddBackslashA = Win32::API::More->new('SHLWAPI',
    'LPSTR PathAddBackslashA(LPSTR pszPath)');
# my $ret = $PathAddBackslashA->Call($pszPath);
# pszPath : LPSTR in/out -> LPSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い