ホーム › Storage.FileSystem › CheckNameLegalDOS8Dot3A

CheckNameLegalDOS8Dot3A

関数

名前が有効な8.3形式DOS名かを検証する(ANSI版)。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL CheckNameLegalDOS8Dot3A(
    LPCSTR lpName,
    LPSTR lpOemName,   // optional
    DWORD OemNameSize,
    BOOL* pbNameContainsSpaces,   // optional
    BOOL* pbNameLegal
);

パラメーター

名前	型	方向	説明
lpName	LPCSTR	in	8.3 形式のファイル名です。
lpOemName	LPSTR	outoptional	Name に対応する OEM 文字列を受け取るバッファーへのポインターです。このパラメーターには NULL を指定できます。
OemNameSize	DWORD	in	lpOemName バッファーのサイズ(文字数)です。lpOemName が NULL の場合、このパラメーターは 0(ゼロ)でなければなりません。
pbNameContainsSpaces	BOOL*	outoptional	名前にスペースが含まれているかどうかを示します。このパラメーターには NULL を指定できます。名前が有効な 8.3 FAT ファイルシステム名でない場合、このパラメーターは未定義です。
pbNameLegal	BOOL*	out	関数が成功した場合、このパラメーターは、現在の OEM コードページをファイル名に適用したときに、そのファイル名が有効な 8.3 FAT ファイル名であるかどうかを示します。

戻り値の型: BOOL

公式ドキュメント

指定された名前を FAT ファイルシステム上でファイルを作成するために使用できるかどうかを判定します。(ANSI)

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0(ゼロ)になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数は、ファイル名を 16 ビット Windows ベースのアプリケーションまたは MS-DOS ベースのアプリケーションに渡せるかどうかを判定するために使用できます。

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 は、継続的可用性機能を持つ共有上で短い名前をサポートしないため、この関数は常に 0(失敗)を返すことに注意してください。

メモ

winbase.h ヘッダーは、CheckNameLegalDOS8Dot3 を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディングに依存しないこのエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL CheckNameLegalDOS8Dot3A(
    LPCSTR lpName,
    LPSTR lpOemName,   // optional
    DWORD OemNameSize,
    BOOL* pbNameContainsSpaces,   // optional
    BOOL* pbNameLegal
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CheckNameLegalDOS8Dot3A(
    [MarshalAs(UnmanagedType.LPStr)] string lpName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpOemName,   // LPSTR optional, out
    uint OemNameSize,   // DWORD
    IntPtr pbNameContainsSpaces,   // BOOL* optional, out
    out bool pbNameLegal   // BOOL* out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CheckNameLegalDOS8Dot3A(
    <MarshalAs(UnmanagedType.LPStr)> lpName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpOemName As System.Text.StringBuilder,   ' LPSTR optional, out
    OemNameSize As UInteger,   ' DWORD
    pbNameContainsSpaces As IntPtr,   ' BOOL* optional, out
    <Out> ByRef pbNameLegal As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpName : LPCSTR
' lpOemName : LPSTR optional, out
' OemNameSize : DWORD
' pbNameContainsSpaces : BOOL* optional, out
' pbNameLegal : BOOL* out
Declare PtrSafe Function CheckNameLegalDOS8Dot3A Lib "kernel32" ( _
    ByVal lpName As String, _
    ByVal lpOemName As String, _
    ByVal OemNameSize As Long, _
    ByVal pbNameContainsSpaces As LongPtr, _
    ByRef pbNameLegal As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CheckNameLegalDOS8Dot3A = ctypes.windll.kernel32.CheckNameLegalDOS8Dot3A
CheckNameLegalDOS8Dot3A.restype = wintypes.BOOL
CheckNameLegalDOS8Dot3A.argtypes = [
    wintypes.LPCSTR,  # lpName : LPCSTR
    wintypes.LPSTR,  # lpOemName : LPSTR optional, out
    wintypes.DWORD,  # OemNameSize : DWORD
    ctypes.c_void_p,  # pbNameContainsSpaces : BOOL* optional, out
    ctypes.c_void_p,  # pbNameLegal : BOOL* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CheckNameLegalDOS8Dot3A = Fiddle::Function.new(
  lib['CheckNameLegalDOS8Dot3A'],
  [
    Fiddle::TYPE_VOIDP,  # lpName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpOemName : LPSTR optional, out
    -Fiddle::TYPE_INT,  # OemNameSize : DWORD
    Fiddle::TYPE_VOIDP,  # pbNameContainsSpaces : BOOL* optional, out
    Fiddle::TYPE_VOIDP,  # pbNameLegal : BOOL* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn CheckNameLegalDOS8Dot3A(
        lpName: *const u8,  // LPCSTR
        lpOemName: *mut u8,  // LPSTR optional, out
        OemNameSize: u32,  // DWORD
        pbNameContainsSpaces: *mut i32,  // BOOL* optional, out
        pbNameLegal: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool CheckNameLegalDOS8Dot3A([MarshalAs(UnmanagedType.LPStr)] string lpName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpOemName, uint OemNameSize, IntPtr pbNameContainsSpaces, out bool pbNameLegal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CheckNameLegalDOS8Dot3A' -Namespace Win32 -PassThru
# $api::CheckNameLegalDOS8Dot3A(lpName, lpOemName, OemNameSize, pbNameContainsSpaces, pbNameLegal)

#uselib "KERNEL32.dll"
#func global CheckNameLegalDOS8Dot3A "CheckNameLegalDOS8Dot3A" sptr, sptr, sptr, sptr, sptr
; CheckNameLegalDOS8Dot3A lpName, varptr(lpOemName), OemNameSize, varptr(pbNameContainsSpaces), varptr(pbNameLegal)   ; 戻り値は stat
; lpName : LPCSTR -> "sptr"
; lpOemName : LPSTR optional, out -> "sptr"
; OemNameSize : DWORD -> "sptr"
; pbNameContainsSpaces : BOOL* optional, out -> "sptr"
; pbNameLegal : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global CheckNameLegalDOS8Dot3A "CheckNameLegalDOS8Dot3A" str, var, int, var, var
; res = CheckNameLegalDOS8Dot3A(lpName, lpOemName, OemNameSize, pbNameContainsSpaces, pbNameLegal)
; lpName : LPCSTR -> "str"
; lpOemName : LPSTR optional, out -> "var"
; OemNameSize : DWORD -> "int"
; pbNameContainsSpaces : BOOL* optional, out -> "var"
; pbNameLegal : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global CheckNameLegalDOS8Dot3A "CheckNameLegalDOS8Dot3A" str, sptr, int, sptr, sptr
; res = CheckNameLegalDOS8Dot3A(lpName, varptr(lpOemName), OemNameSize, varptr(pbNameContainsSpaces), varptr(pbNameLegal))
; lpName : LPCSTR -> "str"
; lpOemName : LPSTR optional, out -> "sptr"
; OemNameSize : DWORD -> "int"
; pbNameContainsSpaces : BOOL* optional, out -> "sptr"
; pbNameLegal : BOOL* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。