ホーム › UI.Shell › SHCreateDirectoryExW

SHCreateDirectoryExW

関数

中間階層を含むディレクトリ(Unicode)を作成する。

DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT SHCreateDirectoryExW(
    HWND hwnd,   // optional
    LPCWSTR pszPath,
    const SECURITY_ATTRIBUTES* psa   // optional
);

パラメーター

名前	型	方向	説明
hwnd	HWND	inoptional	親ウィンドウへのハンドル。ユーザーインターフェイスを表示しない場合は、このパラメーターを NULL に設定できます。
pszPath	LPCWSTR	in	ディレクトリの完全修飾パスを指定する、null で終わる文字列へのポインター。この文字列の最大長は、終端の null 文字を含めて 248 文字です。
psa	SECURITY_ATTRIBUTES*	inoptional	ディレクトリのセキュリティ属性を含む SECURITY_ATTRIBUTES 構造体へのポインター。セキュリティ属性を設定する必要がない場合は、このパラメーターを NULL に設定します。

戻り値の型: INT

公式ドキュメント

新しいファイルシステムフォルダーを作成します。セキュリティ属性は省略可能です。(Unicode)

戻り値

型: int

成功した場合は ERROR_SUCCESS を返します。操作が失敗した場合は、ここに記載されているものを含め、その他のエラーコードが返されることがあります。具体的に記載されていない値については、システムエラーコードを参照してください。

戻り値	説明
ERROR_BAD_PATHNAME	pszPath パラメーターに相対パスが設定されました。
ERROR_FILENAME_EXCED_RANGE	pszPath が指すパスが長すぎます。
ERROR_PATH_NOT_FOUND	システムは pszPath が指すパスを見つけられません。パスに無効なエントリが含まれている可能性があります。
ERROR_FILE_EXISTS	ディレクトリが既に存在します。
ERROR_ALREADY_EXISTS	ディレクトリが既に存在します。
ERROR_CANCELLED	ユーザーが操作をキャンセルしました。

解説(Remarks)

この関数は、pszPath で指定された完全修飾パスを持つファイルシステムフォルダーを作成します。1 つ以上の中間フォルダーが存在しない場合は、それらも作成されます。SHCreateDirectoryEx は、ファイルが表示可能であることも確認します。表示できない場合は、次のいずれかの動作になります。

hwnd に有効なウィンドウハンドルが設定されている場合は、ファイルにアクセスできない可能性があることをユーザーに警告するメッセージボックスが表示されます。ユーザーが続行しないことを選択した場合、この関数は ERROR_CANCELLED を返します。
hwnd が NULL に設定されている場合は、ユーザーインターフェイスは表示されず、この関数は ERROR_CANCELLED を返します。

メモ

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

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

各言語での呼び出し定義

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

INT SHCreateDirectoryExW(
    HWND hwnd,   // optional
    LPCWSTR pszPath,
    const SECURITY_ATTRIBUTES* psa   // optional
);

[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHCreateDirectoryExW(
    IntPtr hwnd,   // HWND optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath,   // LPCWSTR
    IntPtr psa   // SECURITY_ATTRIBUTES* optional
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHCreateDirectoryExW(
    hwnd As IntPtr,   ' HWND optional
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String,   ' LPCWSTR
    psa As IntPtr   ' SECURITY_ATTRIBUTES* optional
) As Integer
End Function

' hwnd : HWND optional
' pszPath : LPCWSTR
' psa : SECURITY_ATTRIBUTES* optional
Declare PtrSafe Function SHCreateDirectoryExW Lib "shell32" ( _
    ByVal hwnd As LongPtr, _
    ByVal pszPath As LongPtr, _
    ByVal psa 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

SHCreateDirectoryExW = ctypes.windll.shell32.SHCreateDirectoryExW
SHCreateDirectoryExW.restype = ctypes.c_int
SHCreateDirectoryExW.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
    ctypes.c_void_p,  # psa : SECURITY_ATTRIBUTES* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHCreateDirectoryExW = Fiddle::Function.new(
  lib['SHCreateDirectoryExW'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND optional
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # psa : SECURITY_ATTRIBUTES* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shell32")]
extern "system" {
    fn SHCreateDirectoryExW(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        pszPath: *const u16,  // LPCWSTR
        psa: *const SECURITY_ATTRIBUTES  // SECURITY_ATTRIBUTES* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern int SHCreateDirectoryExW(IntPtr hwnd, [MarshalAs(UnmanagedType.LPWStr)] string pszPath, IntPtr psa);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHCreateDirectoryExW' -Namespace Win32 -PassThru
# $api::SHCreateDirectoryExW(hwnd, pszPath, psa)

#uselib "SHELL32.dll"
#func global SHCreateDirectoryExW "SHCreateDirectoryExW" wptr, wptr, wptr
; SHCreateDirectoryExW hwnd, pszPath, varptr(psa)   ; 戻り値は stat
; hwnd : HWND optional -> "wptr"
; pszPath : LPCWSTR -> "wptr"
; psa : SECURITY_ATTRIBUTES* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHCreateDirectoryExW "SHCreateDirectoryExW" sptr, wstr, var
; res = SHCreateDirectoryExW(hwnd, pszPath, psa)
; hwnd : HWND optional -> "sptr"
; pszPath : LPCWSTR -> "wstr"
; psa : SECURITY_ATTRIBUTES* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHCreateDirectoryExW "SHCreateDirectoryExW" sptr, wstr, sptr
; res = SHCreateDirectoryExW(hwnd, pszPath, varptr(psa))
; hwnd : HWND optional -> "sptr"
; pszPath : LPCWSTR -> "wstr"
; psa : SECURITY_ATTRIBUTES* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。