PathFindNextComponentA
関数シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
LPSTR PathFindNextComponentA(
LPCSTR pszPath
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszPath | LPCSTR | in | 解析するパスを格納した、null 終端文字列へのポインターです。この文字列は、終端の null 文字を含めて MAX_PATH 文字を超えてはなりません。パスのコンポーネントはバックスラッシュで区切られます。たとえば、パス "c:\path1\path2\file.txt" には、c:、path1、path2、file.txt という 4 つのコンポーネントが含まれます。 |
戻り値の型: LPSTR
公式ドキュメント
パスを解析し、最初のバックスラッシュ以降の部分を返します。(ANSI)
戻り値
型: PTSTR
切り詰められたパスを格納した、null 終端文字列へのポインターを返します。
pszPath がパスの最後のコンポーネントを指している場合、この関数は終端の null 文字へのポインターを返します。
pszPath が終端の null 文字を指している場合、または呼び出しが失敗した場合、この関数は NULL を返します。
解説(Remarks)
PathFindNextComponent は、バックスラッシュ("\")が見つかるまでパス文字列をたどり、その位置までのすべて(バックスラッシュを含む)を無視して、残りのパスを返します。したがって、パスがバックスラッシュで始まる場合(\path1\path2 など)、この関数は単に先頭のバックスラッシュを取り除いて残り(path1\path2)を返します。
例
次の単純なコンソールアプリケーションは、さまざまな文字列を PathFindNextComponent に渡し、この関数がパスコンポーネントとして何を認識し、何を返すかを示します。このコードを Visual Studio で実行するには、Shlwapi.lib をリンクし、プロジェクト設定のプリプロセッサコマンドで UNICODE を定義する必要があります。
#include <windows.h>
#include <iostream>
#include <shlwapi.h>
#pragma comment(lib, "shlwapi.lib") // Link to this file.
int main()
{
using namespace std;
PCWSTR path = L"c:\\path1\\path2\\file.txt";
// This loop passes a full path to PathFindNextComponent and feeds the
// results of that call back into the function until the entire path has
// been walked.
while (path)
{
PCWSTR oldPath = path;
path = PathFindNextComponent(path);
// The path variable pointed to the terminating null character.
if (path == NULL)
{
wcout << L"The terminating null character returns NULL\n\n";
}
// The path variable pointed to a path with only one component.
else if (*path == 0)
{
wcout << L"The path " << oldPath
<< L" returns a pointer to the terminating null character\n";
}
else
{
wcout << L"The path " << oldPath << L" returns " << path << L"\n";
}
}
// These calls demonstrate the results of different path forms.
// Note that where those paths begin with backslashes, those
// backslashes are merely stripped away and the entire path is returned.
PCWSTR path1 = L"\\path1";
wcout << L"The path " << path1 << L" returns "
<< PathFindNextComponent(path1);
PCWSTR path2 = L"\\path1\\path2";
wcout << L"\nThe path " << path2 << L" returns "
<< PathFindNextComponent(path2);
PCWSTR path3 = L"path1\\path2";
wcout << L"\nThe path " << path3 << L" returns "
<< PathFindNextComponent(path3);
wcout << L"\nThe path " << L"c:\\file.txt" << L" returns "
<< PathFindNextComponent(L"c:\\file.txt");
return 0;
}
OUTPUT:
===========
The path c:\path1\path2\file.txt returns path1\path2\file.txt
The path path1\path2\file.txt returns path2\file.txt
The path path2\file.txt returns file.txt
The path file.txt returns a pointer to the terminating null character
The terminating null character returns NULL
The path \path1 returns path1
The path \path1\path2 returns path1\path2
The path path1\path2 returns path2
The path c:\file.txt returns file.txt
shlwapi.h ヘッダーは、PathFindNextComponent を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
LPSTR PathFindNextComponentA(
LPCSTR pszPath
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr PathFindNextComponentA(
[MarshalAs(UnmanagedType.LPStr)] string pszPath // LPCSTR
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathFindNextComponentA(
<MarshalAs(UnmanagedType.LPStr)> pszPath As String ' LPCSTR
) As IntPtr
End Function' pszPath : LPCSTR
Declare PtrSafe Function PathFindNextComponentA 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
PathFindNextComponentA = ctypes.windll.shlwapi.PathFindNextComponentA
PathFindNextComponentA.restype = wintypes.LPSTR
PathFindNextComponentA.argtypes = [
wintypes.LPCSTR, # pszPath : LPCSTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
PathFindNextComponentA = Fiddle::Function.new(
lib['PathFindNextComponentA'],
[
Fiddle::TYPE_VOIDP, # pszPath : LPCSTR
],
Fiddle::TYPE_VOIDP)#[link(name = "shlwapi")]
extern "system" {
fn PathFindNextComponentA(
pszPath: *const u8 // LPCSTR
) -> *mut u8;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr PathFindNextComponentA([MarshalAs(UnmanagedType.LPStr)] string pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathFindNextComponentA' -Namespace Win32 -PassThru
# $api::PathFindNextComponentA(pszPath)#uselib "SHLWAPI.dll"
#func global PathFindNextComponentA "PathFindNextComponentA" sptr
; PathFindNextComponentA pszPath ; 戻り値は stat
; pszPath : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global PathFindNextComponentA "PathFindNextComponentA" str
; res = PathFindNextComponentA(pszPath)
; pszPath : LPCSTR -> "str"; LPSTR PathFindNextComponentA(LPCSTR pszPath)
#uselib "SHLWAPI.dll"
#cfunc global PathFindNextComponentA "PathFindNextComponentA" str
; res = PathFindNextComponentA(pszPath)
; pszPath : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procPathFindNextComponentA = shlwapi.NewProc("PathFindNextComponentA")
)
// pszPath (LPCSTR)
r1, _, err := procPathFindNextComponentA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszPath))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // LPSTRfunction PathFindNextComponentA(
pszPath: PAnsiChar // LPCSTR
): PAnsiChar; stdcall;
external 'SHLWAPI.dll' name 'PathFindNextComponentA';result := DllCall("SHLWAPI\PathFindNextComponentA"
, "AStr", pszPath ; LPCSTR
, "Ptr") ; return: LPSTR●PathFindNextComponentA(pszPath) = DLL("SHLWAPI.dll", "char* PathFindNextComponentA(char*)")
# 呼び出し: PathFindNextComponentA(pszPath)
# pszPath : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn PathFindNextComponentA(
pszPath: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) [*c]const u8;proc PathFindNextComponentA(
pszPath: cstring # LPCSTR
): cstring {.importc: "PathFindNextComponentA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
const(char)* PathFindNextComponentA(
const(char)* pszPath // LPCSTR
);ccall((:PathFindNextComponentA, "SHLWAPI.dll"), stdcall, Cstring,
(Cstring,),
pszPath)
# pszPath : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
const char* PathFindNextComponentA(
const char* pszPath);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathFindNextComponentA(pszPath)
-- pszPath : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathFindNextComponentA = lib.func('__stdcall', 'PathFindNextComponentA', 'void *', ['str']);
// PathFindNextComponentA(pszPath)
// pszPath : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
PathFindNextComponentA: { parameters: ["buffer"], result: "pointer" },
});
// lib.symbols.PathFindNextComponentA(pszPath)
// pszPath : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
const char* PathFindNextComponentA(
const char* pszPath);
C, "SHLWAPI.dll");
// $ffi->PathFindNextComponentA(pszPath);
// pszPath : LPCSTR
// 構造体/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 PathFindNextComponentA(
String pszPath // LPCSTR
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun PathFindNextComponentA = PathFindNextComponentA(
pszPath : UInt8* # LPCSTR
) : UInt8*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef PathFindNextComponentANative = Pointer<Utf8> Function(Pointer<Utf8>);
typedef PathFindNextComponentADart = Pointer<Utf8> Function(Pointer<Utf8>);
final PathFindNextComponentA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<PathFindNextComponentANative, PathFindNextComponentADart>('PathFindNextComponentA');
// pszPath : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PathFindNextComponentA(
pszPath: PAnsiChar // LPCSTR
): PAnsiChar; stdcall;
external 'SHLWAPI.dll' name 'PathFindNextComponentA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PathFindNextComponentA"
c_PathFindNextComponentA :: CString -> IO CString
-- pszPath : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let pathfindnextcomponenta =
foreign "PathFindNextComponentA"
(string @-> returning string)
(* pszPath : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("PathFindNextComponentA" path-find-next-component-a :convention :stdcall) :string
(psz-path :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PathFindNextComponentA = Win32::API::More->new('SHLWAPI',
'LPSTR PathFindNextComponentA(LPCSTR pszPath)');
# my $ret = $PathFindNextComponentA->Call($pszPath);
# pszPath : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f PathFindNextComponentW (Unicode版) — パス中の次の構成要素の先頭ポインタを取得する。