PathFindNextComponentW
関数シグネチャ
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
LPWSTR PathFindNextComponentW(
LPCWSTR pszPath
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszPath | LPCWSTR | in | 解析するパスを格納した null 終端文字列へのポインターです。この文字列は、終端の null 文字を含めて MAX_PATH 文字を超えてはなりません。パスのコンポーネントはバックスラッシュで区切られます。たとえば、パス "c:\path1\path2\file.txt" には c:、path1、path2、file.txt の 4 つのコンポーネントが含まれます。 |
戻り値の型: LPWSTR
公式ドキュメント
パスを解析し、最初のバックスラッシュ以降の部分を返します。(Unicode)
戻り値
型: 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 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイル エラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則 を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
LPWSTR PathFindNextComponentW(
LPCWSTR pszPath
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr PathFindNextComponentW(
[MarshalAs(UnmanagedType.LPWStr)] string pszPath // LPCWSTR
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathFindNextComponentW(
<MarshalAs(UnmanagedType.LPWStr)> pszPath As String ' LPCWSTR
) As IntPtr
End Function' pszPath : LPCWSTR
Declare PtrSafe Function PathFindNextComponentW 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
PathFindNextComponentW = ctypes.windll.shlwapi.PathFindNextComponentW
PathFindNextComponentW.restype = wintypes.LPWSTR
PathFindNextComponentW.argtypes = [
wintypes.LPCWSTR, # pszPath : LPCWSTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
PathFindNextComponentW = Fiddle::Function.new(
lib['PathFindNextComponentW'],
[
Fiddle::TYPE_VOIDP, # pszPath : LPCWSTR
],
Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shlwapi")]
extern "system" {
fn PathFindNextComponentW(
pszPath: *const u16 // LPCWSTR
) -> *mut u16;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr PathFindNextComponentW([MarshalAs(UnmanagedType.LPWStr)] string pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathFindNextComponentW' -Namespace Win32 -PassThru
# $api::PathFindNextComponentW(pszPath)#uselib "SHLWAPI.dll"
#func global PathFindNextComponentW "PathFindNextComponentW" wptr
; PathFindNextComponentW pszPath ; 戻り値は stat
; pszPath : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global PathFindNextComponentW "PathFindNextComponentW" wstr
; res = PathFindNextComponentW(pszPath)
; pszPath : LPCWSTR -> "wstr"; LPWSTR PathFindNextComponentW(LPCWSTR pszPath)
#uselib "SHLWAPI.dll"
#cfunc global PathFindNextComponentW "PathFindNextComponentW" wstr
; res = PathFindNextComponentW(pszPath)
; pszPath : LPCWSTR -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procPathFindNextComponentW = shlwapi.NewProc("PathFindNextComponentW")
)
// pszPath (LPCWSTR)
r1, _, err := procPathFindNextComponentW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPath))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // LPWSTRfunction PathFindNextComponentW(
pszPath: PWideChar // LPCWSTR
): PWideChar; stdcall;
external 'SHLWAPI.dll' name 'PathFindNextComponentW';result := DllCall("SHLWAPI\PathFindNextComponentW"
, "WStr", pszPath ; LPCWSTR
, "Ptr") ; return: LPWSTR●PathFindNextComponentW(pszPath) = DLL("SHLWAPI.dll", "char* PathFindNextComponentW(char*)")
# 呼び出し: PathFindNextComponentW(pszPath)
# pszPath : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shlwapi" fn PathFindNextComponentW(
pszPath: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) [*c]const u16;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc PathFindNextComponentW(
pszPath: WideCString # LPCWSTR
): WideCString {.importc: "PathFindNextComponentW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shlwapi");
extern(Windows)
const(wchar)* PathFindNextComponentW(
const(wchar)* pszPath // LPCWSTR
);ccall((:PathFindNextComponentW, "SHLWAPI.dll"), stdcall, Cwstring,
(Cwstring,),
pszPath)
# pszPath : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
const uint16_t* PathFindNextComponentW(
const uint16_t* pszPath);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathFindNextComponentW(pszPath)
-- pszPath : LPCWSTR
-- 構造体/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 PathFindNextComponentW = lib.func('__stdcall', 'PathFindNextComponentW', 'void *', ['str16']);
// PathFindNextComponentW(pszPath)
// pszPath : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
PathFindNextComponentW: { parameters: ["buffer"], result: "pointer" },
});
// lib.symbols.PathFindNextComponentW(pszPath)
// pszPath : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
const uint16_t* PathFindNextComponentW(
const uint16_t* pszPath);
C, "SHLWAPI.dll");
// $ffi->PathFindNextComponentW(pszPath);
// pszPath : LPCWSTR
// 構造体/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 PathFindNextComponentW(
WString pszPath // LPCWSTR
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shlwapi")]
lib LibSHLWAPI
fun PathFindNextComponentW = PathFindNextComponentW(
pszPath : UInt16* # LPCWSTR
) : UInt16*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef PathFindNextComponentWNative = Pointer<Utf16> Function(Pointer<Utf16>);
typedef PathFindNextComponentWDart = Pointer<Utf16> Function(Pointer<Utf16>);
final PathFindNextComponentW = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<PathFindNextComponentWNative, PathFindNextComponentWDart>('PathFindNextComponentW');
// pszPath : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PathFindNextComponentW(
pszPath: PWideChar // LPCWSTR
): PWideChar; stdcall;
external 'SHLWAPI.dll' name 'PathFindNextComponentW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PathFindNextComponentW"
c_PathFindNextComponentW :: CWString -> IO CWString
-- pszPath : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let pathfindnextcomponentw =
foreign "PathFindNextComponentW"
((ptr uint16_t) @-> returning (ptr uint16_t))
(* pszPath : LPCWSTR -> (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 ("PathFindNextComponentW" path-find-next-component-w :convention :stdcall) (:string :encoding :utf-16le)
(psz-path (:string :encoding :utf-16le))) ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PathFindNextComponentW = Win32::API::More->new('SHLWAPI',
'LPWSTR PathFindNextComponentW(LPCWSTR pszPath)');
# my $ret = $PathFindNextComponentW->Call($pszPath);
# pszPath : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f PathFindNextComponentA (ANSI版) — パス中の次の構成要素の先頭ポインタを取得する。