PathStripToRootA
関数パスをルートディレクトリ部分だけに切り詰める。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
BOOL PathStripToRootA(
LPSTR pszPath
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszPath | LPSTR | inout | 変換するパスを格納した、長さ MAX_PATH の null 終端文字列へのポインター。この関数が正常に終了すると、この文字列にはそのパスから取得したルート情報のみが格納されます。 |
戻り値の型: BOOL
公式ドキュメント
パスからルート情報を除くすべてのファイル要素とディレクトリ要素を削除します。(ANSI)
戻り値
型: BOOL
パス内に有効なドライブ文字が見つかった場合は TRUE を、それ以外の場合は FALSE を返します。
解説(Remarks)
メモ
shlwapi.h ヘッダーは PathStripToRoot をエイリアスとして定義しており、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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
BOOL PathStripToRootA(
LPSTR pszPath
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool PathStripToRootA(
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath // LPSTR in/out
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathStripToRootA(
<MarshalAs(UnmanagedType.LPStr)> pszPath As System.Text.StringBuilder ' LPSTR in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pszPath : LPSTR in/out
Declare PtrSafe Function PathStripToRootA Lib "shlwapi" ( _
ByVal pszPath As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
PathStripToRootA = ctypes.windll.shlwapi.PathStripToRootA
PathStripToRootA.restype = wintypes.BOOL
PathStripToRootA.argtypes = [
wintypes.LPSTR, # pszPath : LPSTR in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
PathStripToRootA = Fiddle::Function.new(
lib['PathStripToRootA'],
[
Fiddle::TYPE_VOIDP, # pszPath : LPSTR in/out
],
Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn PathStripToRootA(
pszPath: *mut u8 // LPSTR in/out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern bool PathStripToRootA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathStripToRootA' -Namespace Win32 -PassThru
# $api::PathStripToRootA(pszPath)#uselib "SHLWAPI.dll"
#func global PathStripToRootA "PathStripToRootA" sptr
; PathStripToRootA varptr(pszPath) ; 戻り値は stat
; pszPath : LPSTR in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHLWAPI.dll" #cfunc global PathStripToRootA "PathStripToRootA" var ; res = PathStripToRootA(pszPath) ; pszPath : LPSTR in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global PathStripToRootA "PathStripToRootA" sptr ; res = PathStripToRootA(varptr(pszPath)) ; pszPath : LPSTR in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL PathStripToRootA(LPSTR pszPath) #uselib "SHLWAPI.dll" #cfunc global PathStripToRootA "PathStripToRootA" var ; res = PathStripToRootA(pszPath) ; pszPath : LPSTR in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL PathStripToRootA(LPSTR pszPath) #uselib "SHLWAPI.dll" #cfunc global PathStripToRootA "PathStripToRootA" intptr ; res = PathStripToRootA(varptr(pszPath)) ; pszPath : LPSTR in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procPathStripToRootA = shlwapi.NewProc("PathStripToRootA")
)
// pszPath (LPSTR in/out)
r1, _, err := procPathStripToRootA.Call(
uintptr(pszPath),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction PathStripToRootA(
pszPath: PAnsiChar // LPSTR in/out
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'PathStripToRootA';result := DllCall("SHLWAPI\PathStripToRootA"
, "Ptr", pszPath ; LPSTR in/out
, "Int") ; return: BOOL●PathStripToRootA(pszPath) = DLL("SHLWAPI.dll", "bool PathStripToRootA(char*)")
# 呼び出し: PathStripToRootA(pszPath)
# pszPath : LPSTR in/out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn PathStripToRootA(
pszPath: [*c]u8 // LPSTR in/out
) callconv(std.os.windows.WINAPI) i32;proc PathStripToRootA(
pszPath: ptr char # LPSTR in/out
): int32 {.importc: "PathStripToRootA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
int PathStripToRootA(
char* pszPath // LPSTR in/out
);ccall((:PathStripToRootA, "SHLWAPI.dll"), stdcall, Int32,
(Ptr{UInt8},),
pszPath)
# pszPath : LPSTR in/out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t PathStripToRootA(
char* pszPath);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathStripToRootA(pszPath)
-- pszPath : LPSTR in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathStripToRootA = lib.func('__stdcall', 'PathStripToRootA', 'int32_t', ['char *']);
// PathStripToRootA(pszPath)
// pszPath : LPSTR in/out -> 'char *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
PathStripToRootA: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.PathStripToRootA(pszPath)
// pszPath : LPSTR in/out -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t PathStripToRootA(
char* pszPath);
C, "SHLWAPI.dll");
// $ffi->PathStripToRootA(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);
boolean PathStripToRootA(
byte[] pszPath // LPSTR in/out
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun PathStripToRootA = PathStripToRootA(
pszPath : UInt8* # LPSTR in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef PathStripToRootANative = Int32 Function(Pointer<Utf8>);
typedef PathStripToRootADart = int Function(Pointer<Utf8>);
final PathStripToRootA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<PathStripToRootANative, PathStripToRootADart>('PathStripToRootA');
// pszPath : LPSTR in/out -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PathStripToRootA(
pszPath: PAnsiChar // LPSTR in/out
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'PathStripToRootA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PathStripToRootA"
c_PathStripToRootA :: CString -> IO CInt
-- pszPath : LPSTR in/out -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let pathstriptoroota =
foreign "PathStripToRootA"
(string @-> returning int32_t)
(* 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 ("PathStripToRootA" path-strip-to-root-a :convention :stdcall) :int32
(psz-path :pointer)) ; LPSTR in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PathStripToRootA = Win32::API::More->new('SHLWAPI',
'BOOL PathStripToRootA(LPSTR pszPath)');
# my $ret = $PathStripToRootA->Call($pszPath);
# pszPath : LPSTR in/out -> LPSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f PathStripToRootW (Unicode版) — パスをルートディレクトリ部分だけに切り詰める。