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

CreateDirectoryExA

関数
テンプレートを指定してディレクトリを作成する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CreateDirectoryExA(
    LPCSTR lpTemplateDirectory,
    LPCSTR lpNewDirectory,
    SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);

パラメーター

名前方向説明
lpTemplateDirectoryLPCSTRin

新しいディレクトリを作成する際にテンプレートとして使用するディレクトリのパス。

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

ヒント

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

lpNewDirectoryLPCSTRin

作成するディレクトリのパス。

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

ヒント

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

lpSecurityAttributesSECURITY_ATTRIBUTES*inoptional

SECURITY_ATTRIBUTES 構造体へのポインター。構造体の lpSecurityDescriptor メンバーは、新しいディレクトリのセキュリティ記述子を指定します。

lpSecurityAttributesNULL の場合、ディレクトリには既定のセキュリティ記述子が割り当てられます。ディレクトリの既定のセキュリティ記述子に含まれるアクセス制御リスト (ACL) は、その親ディレクトリから継承されます。

このパラメーターが効果を持つためには、対象のファイルシステムがファイルおよびディレクトリのセキュリティをサポートしている必要があります。 これは、GetVolumeInformationFS_PERSISTENT_ACLS を返すことで示されます。

戻り値の型: BOOL

公式ドキュメント

指定したテンプレートディレクトリの属性を持つ新しいディレクトリを作成します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。発生し得るエラーには次のものがあります。

戻りコード 説明
ERROR_ALREADY_EXISTS
指定したディレクトリは既に存在します。
ERROR_PATH_NOT_FOUND
1 つ以上の中間ディレクトリが存在しません。この関数はパス中の最終ディレクトリのみを作成します。パス上のすべての中間ディレクトリを作成するには、 SHCreateDirectoryEx 関数を使用します。

解説(Remarks)

CreateDirectoryEx 関数を使用すると、 他のディレクトリからストリーム情報を継承するディレクトリを作成できます。この関数は、たとえば、ディレクトリの内容を属性として正しく識別するために必要なリソースストリームを持つ Macintosh ディレクトリを使用している場合に役立ちます。

NTFS ファイルシステムなど一部のファイルシステムは、個々のファイルおよびディレクトリに対する圧縮または暗号化をサポートしています。そのようなファイルシステム用にフォーマットされたボリュームでは、新しいディレクトリは親ディレクトリの圧縮属性および暗号化属性を継承します。

ディレクトリへのハンドルは、 CreateFile 関数を FILE_FLAG_BACKUP_SEMANTICS フラグを設定して呼び出すことで取得できます。コード例については、 CreateFile を参照してください。

継承をサポートするため、このオブジェクトのセキュリティ記述子を照会する関数は、継承が有効であることをヒューリスティックに判定して報告できます。詳細については、 継承可能な ACE の自動伝播 を参照してください。

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

テクノロジ サポート状況
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 透過的フェールオーバー (TFO) はい
スケールアウトファイル共有を使用した SMB 3.0 (SO) はい
クラスター共有ボリュームファイルシステム (CsvFS) はい
回復性ファイルシステム (ReFS) はい
メモ

winbase.h ヘッダーは CreateDirectoryEx を、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 CreateDirectoryExA(
    LPCSTR lpTemplateDirectory,
    LPCSTR lpNewDirectory,
    SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CreateDirectoryExA(
    [MarshalAs(UnmanagedType.LPStr)] string lpTemplateDirectory,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpNewDirectory,   // LPCSTR
    IntPtr lpSecurityAttributes   // SECURITY_ATTRIBUTES* optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateDirectoryExA(
    <MarshalAs(UnmanagedType.LPStr)> lpTemplateDirectory As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpNewDirectory As String,   ' LPCSTR
    lpSecurityAttributes As IntPtr   ' SECURITY_ATTRIBUTES* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpTemplateDirectory : LPCSTR
' lpNewDirectory : LPCSTR
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
Declare PtrSafe Function CreateDirectoryExA Lib "kernel32" ( _
    ByVal lpTemplateDirectory As String, _
    ByVal lpNewDirectory As String, _
    ByVal lpSecurityAttributes As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateDirectoryExA = ctypes.windll.kernel32.CreateDirectoryExA
CreateDirectoryExA.restype = wintypes.BOOL
CreateDirectoryExA.argtypes = [
    wintypes.LPCSTR,  # lpTemplateDirectory : LPCSTR
    wintypes.LPCSTR,  # lpNewDirectory : LPCSTR
    ctypes.c_void_p,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateDirectoryExA = kernel32.NewProc("CreateDirectoryExA")
)

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

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

typedef CreateDirectoryExANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>);
typedef CreateDirectoryExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>);
final CreateDirectoryExA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateDirectoryExANative, CreateDirectoryExADart>('CreateDirectoryExA');
// lpTemplateDirectory : LPCSTR -> Pointer<Utf8>
// lpNewDirectory : LPCSTR -> Pointer<Utf8>
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateDirectoryExA(
  lpTemplateDirectory: PAnsiChar;   // LPCSTR
  lpNewDirectory: PAnsiChar;   // LPCSTR
  lpSecurityAttributes: Pointer   // SECURITY_ATTRIBUTES* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CreateDirectoryExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateDirectoryExA"
  c_CreateDirectoryExA :: CString -> CString -> Ptr () -> IO CInt
-- lpTemplateDirectory : LPCSTR -> CString
-- lpNewDirectory : LPCSTR -> CString
-- lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createdirectoryexa =
  foreign "CreateDirectoryExA"
    (string @-> string @-> (ptr void) @-> returning int32_t)
(* lpTemplateDirectory : LPCSTR -> string *)
(* lpNewDirectory : LPCSTR -> string *)
(* lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateDirectoryExA" create-directory-ex-a :convention :stdcall) :int32
  (lp-template-directory :string)   ; LPCSTR
  (lp-new-directory :string)   ; LPCSTR
  (lp-security-attributes :pointer))   ; SECURITY_ATTRIBUTES* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateDirectoryExA = Win32::API::More->new('KERNEL32',
    'BOOL CreateDirectoryExA(LPCSTR lpTemplateDirectory, LPCSTR lpNewDirectory, LPVOID lpSecurityAttributes)');
# my $ret = $CreateDirectoryExA->Call($lpTemplateDirectory, $lpNewDirectory, $lpSecurityAttributes);
# lpTemplateDirectory : LPCSTR -> LPCSTR
# lpNewDirectory : LPCSTR -> LPCSTR
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型