Win32 API 日本語リファレンス
ホームStorage.FileSystem › GetLongPathNameA

GetLongPathNameA

関数
短い形式のパスを長い形式のパスに変換する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD GetLongPathNameA(
    LPCSTR lpszShortPath,
    LPSTR lpszLongPath,   // optional
    DWORD cchBuffer
);

パラメーター

名前方向説明
lpszShortPathLPCSTRin変換するパス。
lpszLongPathLPSTRoutoptional

ロングパスを受け取るバッファーへのポインター。

lpszShortPath パラメーターに使用したのと同じバッファーを使用できます。

cchBufferDWORDinlpszLongPath が指すバッファーのサイズ( TCHAR 単位)。

戻り値の型: DWORD

公式ドキュメント

指定されたパスをロング形式に変換します。(ANSI)

戻り値

関数が成功した場合、戻り値は lpszLongPath にコピーされた文字列の長さ(TCHAR 単位)であり、終端の null 文字は含まれません。

lpszLongPath バッファーがパスを格納するには小さすぎる場合、戻り値はパスと終端の null 文字を保持するために必要なバッファーのサイズ(TCHAR 単位)になります。

ファイルが存在しないなど、その他の理由で関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

多くのファイルシステムでは、ショートファイル名にはチルダ()文字が含まれます。ただし、すべてのファイルシステムがこの規則に従うわけではありません。したがって、パスにチルダ()文字が含まれていないからといって、GetLongPathName の呼び出しを省略できると想定しないでください。

ファイルまたはディレクトリが存在するもののロングパスが見つからない場合、GetLongPathName は成功し、lpszShortPath パラメーターが参照する文字列を lpszLongPath パラメーターが参照するバッファーにコピーします。

戻り値が cchBuffer で指定された値より大きい場合、パスを保持するのに十分な大きさのバッファーを指定して関数を再度呼び出すことができます。このケースの例については、GetFullPathName のサンプルコードのセクションを参照してください。

注意 このケースでは戻り値は終端の null 文字を含む長さですが、成功時の戻り値はカウントに終端の null 文字を含みません。
ファイルまたはディレクトリにアクセスできても、そのファイルまたはディレクトリの親ディレクトリの一部にアクセスできない場合があります。その結果、GetLongPathName は、あるパスコンポーネントのロング名を判定するためにその親ディレクトリを照会できない場合に失敗することがあります。このチェックは、ファイル拡張子が 3 文字より長い、または全体の長さが 12 文字より長いディレクトリコンポーネントについてはスキップできます。詳細については、Naming Files, Paths, and NamespacesShort vs. Long Names セクションを参照してください。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされています。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) はい
SMB 3.0 with Scale-out File Shares (SO) はい
Cluster Shared Volume File System (CsvFS) はい
Resilient File System (ReFS) はい

GetLongPathName を使用する例については、GetFullPathName のサンプルコードのセクションを参照してください。

メモ

fileapi.h ヘッダーは、GetLongPathName を、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)

各言語での呼び出し定義

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

DWORD GetLongPathNameA(
    LPCSTR lpszShortPath,
    LPSTR lpszLongPath,   // optional
    DWORD cchBuffer
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetLongPathNameA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszShortPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszLongPath,   // LPSTR optional, out
    uint cchBuffer   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetLongPathNameA(
    <MarshalAs(UnmanagedType.LPStr)> lpszShortPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszLongPath As System.Text.StringBuilder,   ' LPSTR optional, out
    cchBuffer As UInteger   ' DWORD
) As UInteger
End Function
' lpszShortPath : LPCSTR
' lpszLongPath : LPSTR optional, out
' cchBuffer : DWORD
Declare PtrSafe Function GetLongPathNameA Lib "kernel32" ( _
    ByVal lpszShortPath As String, _
    ByVal lpszLongPath As String, _
    ByVal cchBuffer As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetLongPathNameA = ctypes.windll.kernel32.GetLongPathNameA
GetLongPathNameA.restype = wintypes.DWORD
GetLongPathNameA.argtypes = [
    wintypes.LPCSTR,  # lpszShortPath : LPCSTR
    wintypes.LPSTR,  # lpszLongPath : LPSTR optional, out
    wintypes.DWORD,  # cchBuffer : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetLongPathNameA = kernel32.NewProc("GetLongPathNameA")
)

// lpszShortPath (LPCSTR), lpszLongPath (LPSTR optional, out), cchBuffer (DWORD)
r1, _, err := procGetLongPathNameA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszShortPath))),
	uintptr(lpszLongPath),
	uintptr(cchBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetLongPathNameA(
  lpszShortPath: PAnsiChar;   // LPCSTR
  lpszLongPath: PAnsiChar;   // LPSTR optional, out
  cchBuffer: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetLongPathNameA';
result := DllCall("KERNEL32\GetLongPathNameA"
    , "AStr", lpszShortPath   ; LPCSTR
    , "Ptr", lpszLongPath   ; LPSTR optional, out
    , "UInt", cchBuffer   ; DWORD
    , "UInt")   ; return: DWORD
●GetLongPathNameA(lpszShortPath, lpszLongPath, cchBuffer) = DLL("KERNEL32.dll", "dword GetLongPathNameA(char*, char*, dword)")
# 呼び出し: GetLongPathNameA(lpszShortPath, lpszLongPath, cchBuffer)
# lpszShortPath : LPCSTR -> "char*"
# lpszLongPath : LPSTR optional, out -> "char*"
# cchBuffer : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef GetLongPathNameANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef GetLongPathNameADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final GetLongPathNameA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetLongPathNameANative, GetLongPathNameADart>('GetLongPathNameA');
// lpszShortPath : LPCSTR -> Pointer<Utf8>
// lpszLongPath : LPSTR optional, out -> Pointer<Utf8>
// cchBuffer : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetLongPathNameA(
  lpszShortPath: PAnsiChar;   // LPCSTR
  lpszLongPath: PAnsiChar;   // LPSTR optional, out
  cchBuffer: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetLongPathNameA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetLongPathNameA"
  c_GetLongPathNameA :: CString -> CString -> Word32 -> IO Word32
-- lpszShortPath : LPCSTR -> CString
-- lpszLongPath : LPSTR optional, out -> CString
-- cchBuffer : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getlongpathnamea =
  foreign "GetLongPathNameA"
    (string @-> string @-> uint32_t @-> returning uint32_t)
(* lpszShortPath : LPCSTR -> string *)
(* lpszLongPath : LPSTR optional, out -> string *)
(* cchBuffer : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetLongPathNameA" get-long-path-name-a :convention :stdcall) :uint32
  (lpsz-short-path :string)   ; LPCSTR
  (lpsz-long-path :pointer)   ; LPSTR optional, out
  (cch-buffer :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetLongPathNameA = Win32::API::More->new('KERNEL32',
    'DWORD GetLongPathNameA(LPCSTR lpszShortPath, LPSTR lpszLongPath, DWORD cchBuffer)');
# my $ret = $GetLongPathNameA->Call($lpszShortPath, $lpszLongPath, $cchBuffer);
# lpszShortPath : LPCSTR -> LPCSTR
# lpszLongPath : LPSTR optional, out -> LPSTR
# cchBuffer : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目