SHPathPrepareForWriteW
関数シグネチャ
// SHELL32.dll (Unicode / -W)
#include <windows.h>
HRESULT SHPathPrepareForWriteW(
HWND hwnd, // optional
IUnknown* punkEnableModless, // optional
LPCWSTR pszPath,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hwnd | HWND | inoptional | 作成する必要があるユーザーインターフェイスウィンドウの親ウィンドウとして使用するウィンドウへのハンドル。NULL を指定した場合、ユーザーインターフェイスウィンドウは作成されません。 |
| punkEnableModless | IUnknown* | inoptional | EnableModeless メソッドを実装する IOleInPlaceActiveObject オブジェクトを指定する IUnknown インターフェイスへのポインター。 |
| pszPath | LPCWSTR | in | 書き込みに対して有効かどうかを検証するパスを指定する、最大長 MAX_PATH の null 終端文字列へのポインター。UNC パスまたはファイルドライブパスを指定できます。 |
| dwFlags | DWORD | in | 動作オプションを決定するフラグ。このパラメーターには、以下の値の組み合わせを指定できます。 SHPPFW_NONE新しいディレクトリを作成しません。 SHPPFW_DEFAULT既定値。ディレクトリを作成する必要がある場合でも、ユーザーに確認を求めません。これは SHPPFW_DIRCREATE と同一です。SHPPFW_ASKDIRCREATE と一緒に渡さないでください。 SHPPFW_DIRCREATEユーザーに確認を求めずにディレクトリを作成します。SHPPFW_ASKDIRCREATE と一緒に渡さないでください。 SHPPFW_ASKDIRCREATEディレクトリを作成する前にユーザーに確認を求めます。SHPPFW_DIRCREATE と一緒に渡さないでください。 SHPPFW_IGNOREFILENAMEpszPath の最後の項目はファイル名であるため、無視します。たとえば、pszPath="C:\MyDir\MyFile.doc" の場合、"C:\MyDir" のみを使用します。pszPath="C:\MyFirDir\MySecDir" の場合、"C:\MyFirDir" のみを使用します。 SHPPFW_NOWRITECHECK現在実装されていません。 SHPPFW_MEDIACHECKONLYWindows XP 以降。 ユーザーによるキャンセル以外の失敗が発生し、かつ hwnd が NULL でない場合に表示される「アクセスできません」というエラーメッセージボックスを抑制します。 - dwFlags.SHPPFW_ASKDIRCREATEディレクトリを作成する前にユーザーに確認を求めます。SHPPFW_DIRCREATE と一緒に渡さないでください。 - dwFlags.SHPPFW_DEFAULT既定値。ディレクトリを作成する必要がある場合でも、ユーザーに確認を求めません。これは SHPPFW_DIRCREATE と同一です。SHPPFW_ASKDIRCREATE と一緒に渡さないでください。 - dwFlags.SHPPFW_DIRCREATEユーザーに確認を求めずにディレクトリを作成します。SHPPFW_ASKDIRCREATE と一緒に渡さないでください。 - dwFlags.SHPPFW_IGNOREFILENAMEpszPath の最後の項目はファイル名であるため、無視します。たとえば、pszPath="C:\MyDir\MyFile.doc" の場合、"C:\MyDir" のみを使用します。pszPath="C:\MyFirDir\MySecDir" の場合、"C:\MyFirDir" のみを使用します。 - dwFlags.SHPPFW_MEDIACHECKONLYWindows XP 以降。 ユーザーによるキャンセル以外の失敗が発生し、かつ hwnd が NULL でない場合に表示される「アクセスできません」というエラーメッセージボックスを抑制します。 - dwFlags.SHPPFW_NONE新しいディレクトリを作成しません。 - dwFlags.SHPPFW_NOWRITECHECK現在実装されていません。 |
戻り値の型: HRESULT
公式ドキュメント
パスが存在するかどうかを確認します。(Unicode)
戻り値
型: HRESULT
パスが利用可能な場合は S_OK を返し、それ以外の場合はエラーコードを返します。S_OK が返されても、メディアが書き込み可能であることを意味するわけではない点に注意してください。これは単にパスが利用可能であることを意味するだけです。
解説(Remarks)
この関数の主な用途は、プログラムがパスを使用する前にそれを確認し、ユーザーに確認を求めるために必要なユーザーインターフェイスを表示することです。たとえば、ドライブ A: のディスクが存在しない場合、ディスクの挿入をユーザーに促すウィンドウが表示されます。
shlobj_core.h ヘッダーは SHPathPrepareForWrite をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則 を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHELL32.dll (Unicode / -W)
#include <windows.h>
HRESULT SHPathPrepareForWriteW(
HWND hwnd, // optional
IUnknown* punkEnableModless, // optional
LPCWSTR pszPath,
DWORD dwFlags
);[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHPathPrepareForWriteW(
IntPtr hwnd, // HWND optional
IntPtr punkEnableModless, // IUnknown* optional
[MarshalAs(UnmanagedType.LPWStr)] string pszPath, // LPCWSTR
uint dwFlags // DWORD
);<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHPathPrepareForWriteW(
hwnd As IntPtr, ' HWND optional
punkEnableModless As IntPtr, ' IUnknown* optional
<MarshalAs(UnmanagedType.LPWStr)> pszPath As String, ' LPCWSTR
dwFlags As UInteger ' DWORD
) As Integer
End Function' hwnd : HWND optional
' punkEnableModless : IUnknown* optional
' pszPath : LPCWSTR
' dwFlags : DWORD
Declare PtrSafe Function SHPathPrepareForWriteW Lib "shell32" ( _
ByVal hwnd As LongPtr, _
ByVal punkEnableModless As LongPtr, _
ByVal pszPath As LongPtr, _
ByVal dwFlags As Long) 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
SHPathPrepareForWriteW = ctypes.windll.shell32.SHPathPrepareForWriteW
SHPathPrepareForWriteW.restype = ctypes.c_int
SHPathPrepareForWriteW.argtypes = [
wintypes.HANDLE, # hwnd : HWND optional
ctypes.c_void_p, # punkEnableModless : IUnknown* optional
wintypes.LPCWSTR, # pszPath : LPCWSTR
wintypes.DWORD, # dwFlags : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHELL32.dll')
SHPathPrepareForWriteW = Fiddle::Function.new(
lib['SHPathPrepareForWriteW'],
[
Fiddle::TYPE_VOIDP, # hwnd : HWND optional
Fiddle::TYPE_VOIDP, # punkEnableModless : IUnknown* optional
Fiddle::TYPE_VOIDP, # pszPath : LPCWSTR
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shell32")]
extern "system" {
fn SHPathPrepareForWriteW(
hwnd: *mut core::ffi::c_void, // HWND optional
punkEnableModless: *mut core::ffi::c_void, // IUnknown* optional
pszPath: *const u16, // LPCWSTR
dwFlags: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern int SHPathPrepareForWriteW(IntPtr hwnd, IntPtr punkEnableModless, [MarshalAs(UnmanagedType.LPWStr)] string pszPath, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHPathPrepareForWriteW' -Namespace Win32 -PassThru
# $api::SHPathPrepareForWriteW(hwnd, punkEnableModless, pszPath, dwFlags)#uselib "SHELL32.dll"
#func global SHPathPrepareForWriteW "SHPathPrepareForWriteW" wptr, wptr, wptr, wptr
; SHPathPrepareForWriteW hwnd, punkEnableModless, pszPath, dwFlags ; 戻り値は stat
; hwnd : HWND optional -> "wptr"
; punkEnableModless : IUnknown* optional -> "wptr"
; pszPath : LPCWSTR -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHELL32.dll"
#cfunc global SHPathPrepareForWriteW "SHPathPrepareForWriteW" sptr, sptr, wstr, int
; res = SHPathPrepareForWriteW(hwnd, punkEnableModless, pszPath, dwFlags)
; hwnd : HWND optional -> "sptr"
; punkEnableModless : IUnknown* optional -> "sptr"
; pszPath : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"; HRESULT SHPathPrepareForWriteW(HWND hwnd, IUnknown* punkEnableModless, LPCWSTR pszPath, DWORD dwFlags)
#uselib "SHELL32.dll"
#cfunc global SHPathPrepareForWriteW "SHPathPrepareForWriteW" intptr, intptr, wstr, int
; res = SHPathPrepareForWriteW(hwnd, punkEnableModless, pszPath, dwFlags)
; hwnd : HWND optional -> "intptr"
; punkEnableModless : IUnknown* optional -> "intptr"
; pszPath : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shell32 = windows.NewLazySystemDLL("SHELL32.dll")
procSHPathPrepareForWriteW = shell32.NewProc("SHPathPrepareForWriteW")
)
// hwnd (HWND optional), punkEnableModless (IUnknown* optional), pszPath (LPCWSTR), dwFlags (DWORD)
r1, _, err := procSHPathPrepareForWriteW.Call(
uintptr(hwnd),
uintptr(punkEnableModless),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPath))),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction SHPathPrepareForWriteW(
hwnd: THandle; // HWND optional
punkEnableModless: Pointer; // IUnknown* optional
pszPath: PWideChar; // LPCWSTR
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHELL32.dll' name 'SHPathPrepareForWriteW';result := DllCall("SHELL32\SHPathPrepareForWriteW"
, "Ptr", hwnd ; HWND optional
, "Ptr", punkEnableModless ; IUnknown* optional
, "WStr", pszPath ; LPCWSTR
, "UInt", dwFlags ; DWORD
, "Int") ; return: HRESULT●SHPathPrepareForWriteW(hwnd, punkEnableModless, pszPath, dwFlags) = DLL("SHELL32.dll", "int SHPathPrepareForWriteW(void*, void*, char*, dword)")
# 呼び出し: SHPathPrepareForWriteW(hwnd, punkEnableModless, pszPath, dwFlags)
# hwnd : HWND optional -> "void*"
# punkEnableModless : IUnknown* optional -> "void*"
# pszPath : LPCWSTR -> "char*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shell32" fn SHPathPrepareForWriteW(
hwnd: ?*anyopaque, // HWND optional
punkEnableModless: ?*anyopaque, // IUnknown* optional
pszPath: [*c]const u16, // LPCWSTR
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SHPathPrepareForWriteW(
hwnd: pointer, # HWND optional
punkEnableModless: pointer, # IUnknown* optional
pszPath: WideCString, # LPCWSTR
dwFlags: uint32 # DWORD
): int32 {.importc: "SHPathPrepareForWriteW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shell32");
extern(Windows)
int SHPathPrepareForWriteW(
void* hwnd, // HWND optional
void* punkEnableModless, // IUnknown* optional
const(wchar)* pszPath, // LPCWSTR
uint dwFlags // DWORD
);ccall((:SHPathPrepareForWriteW, "SHELL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Cvoid}, Cwstring, UInt32),
hwnd, punkEnableModless, pszPath, dwFlags)
# hwnd : HWND optional -> Ptr{Cvoid}
# punkEnableModless : IUnknown* optional -> Ptr{Cvoid}
# pszPath : LPCWSTR -> Cwstring
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t SHPathPrepareForWriteW(
void* hwnd,
void* punkEnableModless,
const uint16_t* pszPath,
uint32_t dwFlags);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHPathPrepareForWriteW(hwnd, punkEnableModless, pszPath, dwFlags)
-- hwnd : HWND optional
-- punkEnableModless : IUnknown* optional
-- pszPath : LPCWSTR
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHPathPrepareForWriteW = lib.func('__stdcall', 'SHPathPrepareForWriteW', 'int32_t', ['void *', 'void *', 'str16', 'uint32_t']);
// SHPathPrepareForWriteW(hwnd, punkEnableModless, pszPath, dwFlags)
// hwnd : HWND optional -> 'void *'
// punkEnableModless : IUnknown* optional -> 'void *'
// pszPath : LPCWSTR -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHELL32.dll", {
SHPathPrepareForWriteW: { parameters: ["pointer", "pointer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.SHPathPrepareForWriteW(hwnd, punkEnableModless, pszPath, dwFlags)
// hwnd : HWND optional -> "pointer"
// punkEnableModless : IUnknown* optional -> "pointer"
// pszPath : LPCWSTR -> "buffer"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SHPathPrepareForWriteW(
void* hwnd,
void* punkEnableModless,
const uint16_t* pszPath,
uint32_t dwFlags);
C, "SHELL32.dll");
// $ffi->SHPathPrepareForWriteW(hwnd, punkEnableModless, pszPath, dwFlags);
// hwnd : HWND optional
// punkEnableModless : IUnknown* optional
// pszPath : LPCWSTR
// dwFlags : 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 Shell32 extends StdCallLibrary {
Shell32 INSTANCE = Native.load("shell32", Shell32.class, W32APIOptions.UNICODE_OPTIONS);
int SHPathPrepareForWriteW(
Pointer hwnd, // HWND optional
Pointer punkEnableModless, // IUnknown* optional
WString pszPath, // LPCWSTR
int dwFlags // DWORD
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shell32")]
lib LibSHELL32
fun SHPathPrepareForWriteW = SHPathPrepareForWriteW(
hwnd : Void*, # HWND optional
punkEnableModless : Void*, # IUnknown* optional
pszPath : UInt16*, # LPCWSTR
dwFlags : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SHPathPrepareForWriteWNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Uint32);
typedef SHPathPrepareForWriteWDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, int);
final SHPathPrepareForWriteW = DynamicLibrary.open('SHELL32.dll')
.lookupFunction<SHPathPrepareForWriteWNative, SHPathPrepareForWriteWDart>('SHPathPrepareForWriteW');
// hwnd : HWND optional -> Pointer<Void>
// punkEnableModless : IUnknown* optional -> Pointer<Void>
// pszPath : LPCWSTR -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHPathPrepareForWriteW(
hwnd: THandle; // HWND optional
punkEnableModless: Pointer; // IUnknown* optional
pszPath: PWideChar; // LPCWSTR
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHELL32.dll' name 'SHPathPrepareForWriteW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHPathPrepareForWriteW"
c_SHPathPrepareForWriteW :: Ptr () -> Ptr () -> CWString -> Word32 -> IO Int32
-- hwnd : HWND optional -> Ptr ()
-- punkEnableModless : IUnknown* optional -> Ptr ()
-- pszPath : LPCWSTR -> CWString
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shpathprepareforwritew =
foreign "SHPathPrepareForWriteW"
((ptr void) @-> (ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* hwnd : HWND optional -> (ptr void) *)
(* punkEnableModless : IUnknown* optional -> (ptr void) *)
(* pszPath : LPCWSTR -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)
(cffi:defcfun ("SHPathPrepareForWriteW" shpath-prepare-for-write-w :convention :stdcall) :int32
(hwnd :pointer) ; HWND optional
(punk-enable-modless :pointer) ; IUnknown* optional
(psz-path (:string :encoding :utf-16le)) ; LPCWSTR
(dw-flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHPathPrepareForWriteW = Win32::API::More->new('SHELL32',
'int SHPathPrepareForWriteW(HANDLE hwnd, LPVOID punkEnableModless, LPCWSTR pszPath, DWORD dwFlags)');
# my $ret = $SHPathPrepareForWriteW->Call($hwnd, $punkEnableModless, $pszPath, $dwFlags);
# hwnd : HWND optional -> HANDLE
# punkEnableModless : IUnknown* optional -> LPVOID
# pszPath : LPCWSTR -> LPCWSTR
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f SHPathPrepareForWriteA (ANSI版) — 書き込みに備えパス(ANSI)の媒体やフォルダーを準備する。