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

GetShortPathNameA

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

シグネチャ

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

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

パラメーター

名前方向説明
lpszLongPathLPCSTRin

パス文字列。

既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳しくは、ファイル、パス、および名前空間の名前付けを参照してください。

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加しなくても MAX_PATH の制限を解除するようにオプトインできます。詳しくは、ファイル、パス、および名前空間の名前付けの「最大パス長の制限」セクションを参照してください。

lpszShortPathLPSTRoutoptional

lpszLongPath で指定したパスの、null で終わる短い形式を受け取るバッファーへのポインター。

このパラメーターに NULLcchBuffer に 0 を渡すと、指定した lpszLongPath に必要なバッファーサイズが常に返されます。

cchBufferDWORDin

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

lpszShortPathNULL を設定した場合は、このパラメーターを 0 に設定します。

戻り値の型: DWORD

公式ドキュメント

指定したパスの短い形式(ショートパス)を取得します。(GetShortPathNameA)

戻り値

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

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

それ以外の理由で関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

lpszLongPath パラメーターで指定するパスは、完全パスや 長いパスである必要はありません。短い形式が、指定したパスより長くなることもあります。

戻り値が cchBuffer パラメーターで指定した値より大きい場合は、 パスを保持できる十分な大きさのバッファーを用意して、関数を再度呼び出すことができます。この場合の例、および動的割り当てに長さ 0 のバッファーを使用する方法については、「サンプルコード」セクションを参照してください。

注意 この場合の戻り値は終端の null 文字を含む長さですが、成功時の 戻り値はカウントに終端の null 文字を含みません。
指定したパスが既に短い形式であり、変換が不要な場合、関数は 指定したパスを lpszShortPath パラメーターで指定したバッファーへ単にコピーします。

lpszShortPath パラメーターには、 lpszLongPath パラメーターと同じ値を設定できます。つまり、ショートパス用の出力バッファーを 入力パス文字列のアドレスに設定できます。その場合は、cchBuffer パラメーターが このバッファーの合計サイズ(TCHAR 単位)を正確に表していることを常に確認してください。

ファイルのロングネームは、ショートネームから GetLongPathName 関数を呼び出すことで取得できます。あるいは、 GetLongPathName が利用できない場合は、パスの各構成要素に対して FindFirstFile を呼び出して、対応するロングネームを取得できます。

ファイルやディレクトリにはアクセスできても、そのファイルやディレクトリの 親ディレクトリの一部にはアクセスできない場合があります。その結果、GetShortPathName は、 あるパス構成要素のショートネームを判定するためにその親ディレクトリを照会できない場合に 失敗することがあります。このチェックは、既にショートネームの要件を満たしているディレクトリ構成要素については省略できます。 詳しくは、ファイル、パス、および名前空間の名前付け「ショートネーム対ロングネーム」セクションを参照してください。

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) はい

SMB 3.0 は、継続的可用性機能を備えた共有でのショートネームをサポートしません。

Resilient File System (ReFS) はショートネームをサポートしません。ディスク上にショートネームを持たないパスに対して GetShortPathName を呼び出すと、呼び出しは成功しますが、代わりにロングネームのパスが返されます。NTFS ボリュームでも、特定のロングネームに対してショートネームが存在する保証はないため、同じ結果になることがあります。

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

次の C++ の例は、動的に割り当てた出力バッファーの使用方法を示しています。
//...
    long     length = 0;
    TCHAR*   buffer = NULL;

// First obtain the size needed by passing NULL and 0.

    length = GetShortPathName(lpszPath, NULL, 0);
    if (length == 0) ErrorExit(TEXT("GetShortPathName"));

// Dynamically allocate the correct size 
// (terminating null char was included in length)

    buffer = new TCHAR[length];

// Now simply call again using same long path.

    length = GetShortPathName(lpszPath, buffer, length);
    if (length == 0) ErrorExit(TEXT("GetShortPathName"));

    _tprintf(TEXT("long name = %s shortname = %s"), lpszPath, buffer);
    
    delete [] buffer;
///...
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetShortPathNameA(
    LPCSTR lpszLongPath,
    LPSTR lpszShortPath,   // optional
    DWORD cchBuffer
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetShortPathNameA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszLongPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszShortPath,   // LPSTR optional, out
    uint cchBuffer   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetShortPathNameA(
    <MarshalAs(UnmanagedType.LPStr)> lpszLongPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszShortPath As System.Text.StringBuilder,   ' LPSTR optional, out
    cchBuffer As UInteger   ' DWORD
) As UInteger
End Function
' lpszLongPath : LPCSTR
' lpszShortPath : LPSTR optional, out
' cchBuffer : DWORD
Declare PtrSafe Function GetShortPathNameA Lib "kernel32" ( _
    ByVal lpszLongPath As String, _
    ByVal lpszShortPath 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

GetShortPathNameA = ctypes.windll.kernel32.GetShortPathNameA
GetShortPathNameA.restype = wintypes.DWORD
GetShortPathNameA.argtypes = [
    wintypes.LPCSTR,  # lpszLongPath : LPCSTR
    wintypes.LPSTR,  # lpszShortPath : 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')
GetShortPathNameA = Fiddle::Function.new(
  lib['GetShortPathNameA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszLongPath : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszShortPath : LPSTR optional, out
    -Fiddle::TYPE_INT,  # cchBuffer : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetShortPathNameA(
        lpszLongPath: *const u8,  // LPCSTR
        lpszShortPath: *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 GetShortPathNameA([MarshalAs(UnmanagedType.LPStr)] string lpszLongPath, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszShortPath, uint cchBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetShortPathNameA' -Namespace Win32 -PassThru
# $api::GetShortPathNameA(lpszLongPath, lpszShortPath, cchBuffer)
#uselib "KERNEL32.dll"
#func global GetShortPathNameA "GetShortPathNameA" sptr, sptr, sptr
; GetShortPathNameA lpszLongPath, varptr(lpszShortPath), cchBuffer   ; 戻り値は stat
; lpszLongPath : LPCSTR -> "sptr"
; lpszShortPath : LPSTR optional, out -> "sptr"
; cchBuffer : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetShortPathNameA "GetShortPathNameA" str, var, int
; res = GetShortPathNameA(lpszLongPath, lpszShortPath, cchBuffer)
; lpszLongPath : LPCSTR -> "str"
; lpszShortPath : LPSTR optional, out -> "var"
; cchBuffer : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetShortPathNameA(LPCSTR lpszLongPath, LPSTR lpszShortPath, DWORD cchBuffer)
#uselib "KERNEL32.dll"
#cfunc global GetShortPathNameA "GetShortPathNameA" str, var, int
; res = GetShortPathNameA(lpszLongPath, lpszShortPath, cchBuffer)
; lpszLongPath : LPCSTR -> "str"
; lpszShortPath : LPSTR optional, out -> "var"
; cchBuffer : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetShortPathNameA = kernel32.NewProc("GetShortPathNameA")
)

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

extern "kernel32" fn GetShortPathNameA(
    lpszLongPath: [*c]const u8, // LPCSTR
    lpszShortPath: [*c]u8, // LPSTR optional, out
    cchBuffer: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc GetShortPathNameA(
    lpszLongPath: cstring,  # LPCSTR
    lpszShortPath: ptr char,  # LPSTR optional, out
    cchBuffer: uint32  # DWORD
): uint32 {.importc: "GetShortPathNameA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint GetShortPathNameA(
    const(char)* lpszLongPath,   // LPCSTR
    char* lpszShortPath,   // LPSTR optional, out
    uint cchBuffer   // DWORD
);
ccall((:GetShortPathNameA, "KERNEL32.dll"), stdcall, UInt32,
      (Cstring, Ptr{UInt8}, UInt32),
      lpszLongPath, lpszShortPath, cchBuffer)
# lpszLongPath : LPCSTR -> Cstring
# lpszShortPath : LPSTR optional, out -> Ptr{UInt8}
# cchBuffer : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetShortPathNameA(
    const char* lpszLongPath,
    char* lpszShortPath,
    uint32_t cchBuffer);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetShortPathNameA(lpszLongPath, lpszShortPath, cchBuffer)
-- lpszLongPath : LPCSTR
-- lpszShortPath : LPSTR optional, out
-- cchBuffer : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetShortPathNameA = lib.func('__stdcall', 'GetShortPathNameA', 'uint32_t', ['str', 'char *', 'uint32_t']);
// GetShortPathNameA(lpszLongPath, lpszShortPath, cchBuffer)
// lpszLongPath : LPCSTR -> 'str'
// lpszShortPath : LPSTR optional, out -> 'char *'
// cchBuffer : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetShortPathNameA: { parameters: ["buffer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.GetShortPathNameA(lpszLongPath, lpszShortPath, cchBuffer)
// lpszLongPath : LPCSTR -> "buffer"
// lpszShortPath : 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 GetShortPathNameA(
    const char* lpszLongPath,
    char* lpszShortPath,
    uint32_t cchBuffer);
C, "KERNEL32.dll");
// $ffi->GetShortPathNameA(lpszLongPath, lpszShortPath, cchBuffer);
// lpszLongPath : LPCSTR
// lpszShortPath : 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 GetShortPathNameA(
        String lpszLongPath,   // LPCSTR
        byte[] lpszShortPath,   // LPSTR optional, out
        int cchBuffer   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetShortPathNameA = GetShortPathNameA(
    lpszLongPath : UInt8*,   # LPCSTR
    lpszShortPath : 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 GetShortPathNameANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef GetShortPathNameADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final GetShortPathNameA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetShortPathNameANative, GetShortPathNameADart>('GetShortPathNameA');
// lpszLongPath : LPCSTR -> Pointer<Utf8>
// lpszShortPath : LPSTR optional, out -> Pointer<Utf8>
// cchBuffer : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetShortPathNameA(
  lpszLongPath: PAnsiChar;   // LPCSTR
  lpszShortPath: PAnsiChar;   // LPSTR optional, out
  cchBuffer: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetShortPathNameA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getshortpathnamea =
  foreign "GetShortPathNameA"
    (string @-> string @-> uint32_t @-> returning uint32_t)
(* lpszLongPath : LPCSTR -> string *)
(* lpszShortPath : 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 ("GetShortPathNameA" get-short-path-name-a :convention :stdcall) :uint32
  (lpsz-long-path :string)   ; LPCSTR
  (lpsz-short-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 $GetShortPathNameA = Win32::API::More->new('KERNEL32',
    'DWORD GetShortPathNameA(LPCSTR lpszLongPath, LPSTR lpszShortPath, DWORD cchBuffer)');
# my $ret = $GetShortPathNameA->Call($lpszLongPath, $lpszShortPath, $cchBuffer);
# lpszLongPath : LPCSTR -> LPCSTR
# lpszShortPath : LPSTR optional, out -> LPSTR
# cchBuffer : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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