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

CreateDirectoryExW

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

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL CreateDirectoryExW(
    LPCWSTR lpTemplateDirectory,
    LPCWSTR lpNewDirectory,
    SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);

パラメーター

名前方向説明
lpTemplateDirectoryLPCWSTRin

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

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

ヒント

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

lpNewDirectoryLPCWSTRin

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

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

ヒント

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

lpSecurityAttributesSECURITY_ATTRIBUTES*inoptional

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

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

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

戻り値の型: BOOL

公式ドキュメント

指定したテンプレートディレクトリの属性を引き継いで、新しいディレクトリを作成します。(Unicode)

戻り値

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

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

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

解説(Remarks)

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

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

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

継承をサポートするために、このオブジェクトのセキュリティ記述子を照会する関数は、継承が有効になっているかどうかをヒューリスティックに判定して報告できます。詳細については、 Automatic Propagation of Inheritable ACEs を参照してください。

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL CreateDirectoryExW(
    LPCWSTR lpTemplateDirectory,
    LPCWSTR lpNewDirectory,
    SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CreateDirectoryExW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpTemplateDirectory,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpNewDirectory,   // LPCWSTR
    IntPtr lpSecurityAttributes   // SECURITY_ATTRIBUTES* optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateDirectoryExW(
    <MarshalAs(UnmanagedType.LPWStr)> lpTemplateDirectory As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpNewDirectory As String,   ' LPCWSTR
    lpSecurityAttributes As IntPtr   ' SECURITY_ATTRIBUTES* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpTemplateDirectory : LPCWSTR
' lpNewDirectory : LPCWSTR
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
Declare PtrSafe Function CreateDirectoryExW Lib "kernel32" ( _
    ByVal lpTemplateDirectory As LongPtr, _
    ByVal lpNewDirectory As LongPtr, _
    ByVal lpSecurityAttributes As LongPtr) As Long
' 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

CreateDirectoryExW = ctypes.windll.kernel32.CreateDirectoryExW
CreateDirectoryExW.restype = wintypes.BOOL
CreateDirectoryExW.argtypes = [
    wintypes.LPCWSTR,  # lpTemplateDirectory : LPCWSTR
    wintypes.LPCWSTR,  # lpNewDirectory : LPCWSTR
    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')
CreateDirectoryExW = Fiddle::Function.new(
  lib['CreateDirectoryExW'],
  [
    Fiddle::TYPE_VOIDP,  # lpTemplateDirectory : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpNewDirectory : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn CreateDirectoryExW(
        lpTemplateDirectory: *const u16,  // LPCWSTR
        lpNewDirectory: *const u16,  // LPCWSTR
        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.Unicode, SetLastError = true)]
public static extern bool CreateDirectoryExW([MarshalAs(UnmanagedType.LPWStr)] string lpTemplateDirectory, [MarshalAs(UnmanagedType.LPWStr)] string lpNewDirectory, IntPtr lpSecurityAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateDirectoryExW' -Namespace Win32 -PassThru
# $api::CreateDirectoryExW(lpTemplateDirectory, lpNewDirectory, lpSecurityAttributes)
#uselib "KERNEL32.dll"
#func global CreateDirectoryExW "CreateDirectoryExW" wptr, wptr, wptr
; CreateDirectoryExW lpTemplateDirectory, lpNewDirectory, varptr(lpSecurityAttributes)   ; 戻り値は stat
; lpTemplateDirectory : LPCWSTR -> "wptr"
; lpNewDirectory : LPCWSTR -> "wptr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global CreateDirectoryExW "CreateDirectoryExW" wstr, wstr, var
; res = CreateDirectoryExW(lpTemplateDirectory, lpNewDirectory, lpSecurityAttributes)
; lpTemplateDirectory : LPCWSTR -> "wstr"
; lpNewDirectory : LPCWSTR -> "wstr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CreateDirectoryExW(LPCWSTR lpTemplateDirectory, LPCWSTR lpNewDirectory, SECURITY_ATTRIBUTES* lpSecurityAttributes)
#uselib "KERNEL32.dll"
#cfunc global CreateDirectoryExW "CreateDirectoryExW" wstr, wstr, var
; res = CreateDirectoryExW(lpTemplateDirectory, lpNewDirectory, lpSecurityAttributes)
; lpTemplateDirectory : LPCWSTR -> "wstr"
; lpNewDirectory : LPCWSTR -> "wstr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateDirectoryExW = kernel32.NewProc("CreateDirectoryExW")
)

// lpTemplateDirectory (LPCWSTR), lpNewDirectory (LPCWSTR), lpSecurityAttributes (SECURITY_ATTRIBUTES* optional)
r1, _, err := procCreateDirectoryExW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpTemplateDirectory))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpNewDirectory))),
	uintptr(lpSecurityAttributes),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CreateDirectoryExW(
  lpTemplateDirectory: PWideChar;   // LPCWSTR
  lpNewDirectory: PWideChar;   // LPCWSTR
  lpSecurityAttributes: Pointer   // SECURITY_ATTRIBUTES* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CreateDirectoryExW';
result := DllCall("KERNEL32\CreateDirectoryExW"
    , "WStr", lpTemplateDirectory   ; LPCWSTR
    , "WStr", lpNewDirectory   ; LPCWSTR
    , "Ptr", lpSecurityAttributes   ; SECURITY_ATTRIBUTES* optional
    , "Int")   ; return: BOOL
●CreateDirectoryExW(lpTemplateDirectory, lpNewDirectory, lpSecurityAttributes) = DLL("KERNEL32.dll", "bool CreateDirectoryExW(char*, char*, void*)")
# 呼び出し: CreateDirectoryExW(lpTemplateDirectory, lpNewDirectory, lpSecurityAttributes)
# lpTemplateDirectory : LPCWSTR -> "char*"
# lpNewDirectory : LPCWSTR -> "char*"
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn CreateDirectoryExW(
    lpTemplateDirectory: [*c]const u16, // LPCWSTR
    lpNewDirectory: [*c]const u16, // LPCWSTR
    lpSecurityAttributes: [*c]SECURITY_ATTRIBUTES // SECURITY_ATTRIBUTES* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc CreateDirectoryExW(
    lpTemplateDirectory: WideCString,  # LPCWSTR
    lpNewDirectory: WideCString,  # LPCWSTR
    lpSecurityAttributes: ptr SECURITY_ATTRIBUTES  # SECURITY_ATTRIBUTES* optional
): int32 {.importc: "CreateDirectoryExW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int CreateDirectoryExW(
    const(wchar)* lpTemplateDirectory,   // LPCWSTR
    const(wchar)* lpNewDirectory,   // LPCWSTR
    SECURITY_ATTRIBUTES* lpSecurityAttributes   // SECURITY_ATTRIBUTES* optional
);
ccall((:CreateDirectoryExW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Ptr{SECURITY_ATTRIBUTES}),
      lpTemplateDirectory, lpNewDirectory, lpSecurityAttributes)
# lpTemplateDirectory : LPCWSTR -> Cwstring
# lpNewDirectory : LPCWSTR -> Cwstring
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Ptr{SECURITY_ATTRIBUTES}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t CreateDirectoryExW(
    const uint16_t* lpTemplateDirectory,
    const uint16_t* lpNewDirectory,
    void* lpSecurityAttributes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CreateDirectoryExW(lpTemplateDirectory, lpNewDirectory, lpSecurityAttributes)
-- lpTemplateDirectory : LPCWSTR
-- lpNewDirectory : LPCWSTR
-- lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CreateDirectoryExW = lib.func('__stdcall', 'CreateDirectoryExW', 'int32_t', ['str16', 'str16', 'void *']);
// CreateDirectoryExW(lpTemplateDirectory, lpNewDirectory, lpSecurityAttributes)
// lpTemplateDirectory : LPCWSTR -> 'str16'
// lpNewDirectory : LPCWSTR -> 'str16'
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CreateDirectoryExW: { parameters: ["buffer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.CreateDirectoryExW(lpTemplateDirectory, lpNewDirectory, lpSecurityAttributes)
// lpTemplateDirectory : LPCWSTR -> "buffer"
// lpNewDirectory : LPCWSTR -> "buffer"
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CreateDirectoryExW(
    const uint16_t* lpTemplateDirectory,
    const uint16_t* lpNewDirectory,
    void* lpSecurityAttributes);
C, "KERNEL32.dll");
// $ffi->CreateDirectoryExW(lpTemplateDirectory, lpNewDirectory, lpSecurityAttributes);
// lpTemplateDirectory : LPCWSTR
// lpNewDirectory : LPCWSTR
// 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.UNICODE_OPTIONS);
    boolean CreateDirectoryExW(
        WString lpTemplateDirectory,   // LPCWSTR
        WString lpNewDirectory,   // LPCWSTR
        Pointer lpSecurityAttributes   // SECURITY_ATTRIBUTES* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun CreateDirectoryExW = CreateDirectoryExW(
    lpTemplateDirectory : UInt16*,   # LPCWSTR
    lpNewDirectory : UInt16*,   # LPCWSTR
    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 CreateDirectoryExWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>);
typedef CreateDirectoryExWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>);
final CreateDirectoryExW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateDirectoryExWNative, CreateDirectoryExWDart>('CreateDirectoryExW');
// lpTemplateDirectory : LPCWSTR -> Pointer<Utf16>
// lpNewDirectory : LPCWSTR -> Pointer<Utf16>
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateDirectoryExW(
  lpTemplateDirectory: PWideChar;   // LPCWSTR
  lpNewDirectory: PWideChar;   // LPCWSTR
  lpSecurityAttributes: Pointer   // SECURITY_ATTRIBUTES* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CreateDirectoryExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let createdirectoryexw =
  foreign "CreateDirectoryExW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* lpTemplateDirectory : LPCWSTR -> (ptr uint16_t) *)
(* lpNewDirectory : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("CreateDirectoryExW" create-directory-ex-w :convention :stdcall) :int32
  (lp-template-directory (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-new-directory (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-security-attributes :pointer))   ; SECURITY_ATTRIBUTES* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateDirectoryExW = Win32::API::More->new('KERNEL32',
    'BOOL CreateDirectoryExW(LPCWSTR lpTemplateDirectory, LPCWSTR lpNewDirectory, LPVOID lpSecurityAttributes)');
# my $ret = $CreateDirectoryExW->Call($lpTemplateDirectory, $lpNewDirectory, $lpSecurityAttributes);
# lpTemplateDirectory : LPCWSTR -> LPCWSTR
# lpNewDirectory : LPCWSTR -> LPCWSTR
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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