ホーム › UI.Shell › SHPathPrepareForWriteA

SHPathPrepareForWriteA

関数

書き込みに備えパス(ANSI)の媒体やフォルダーを準備する。

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

シグネチャ

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

HRESULT SHPathPrepareForWriteA(
    HWND hwnd,   // optional
    IUnknown* punkEnableModless,   // optional
    LPCSTR pszPath,
    DWORD dwFlags
);

パラメーター

名前	型	方向	説明
hwnd	HWND	inoptional	作成が必要なユーザーインターフェイスウィンドウの親ウィンドウを指定するウィンドウへのハンドルです。NULL に設定すると、ユーザーインターフェイスウィンドウは作成されません。
punkEnableModless	IUnknown*	inoptional	EnableModeless メソッドを実装する IOleInPlaceActiveObject オブジェクトを指定する IUnknown インターフェイスへのポインターです。
pszPath	LPCSTR	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_IGNOREFILENAME pszPath の最後の項目はファイル名なので無視します。たとえば、pszPath="C:\MyDir\MyFile.doc" の場合は "C:\MyDir" のみを使用します。pszPath="C:\MyFirDir\MySecDir" の場合は "C:\MyFirDir" のみを使用します。 SHPPFW_NOWRITECHECK 現在実装されていません。 SHPPFW_MEDIACHECKONLY Windows XP 以降。ユーザーによるキャンセル以外の失敗が発生し、かつ hwnd が NULL でない場合に表示される「アクセスできません」というエラーメッセージボックスを抑制します。

戻り値の型: HRESULT

公式ドキュメント

パスが存在するかどうかを確認します。(ANSI)

戻り値

型: HRESULT

パスが利用可能な場合は S_OK を返し、そうでない場合はエラーコードを返します。S_OK が返されても、メディアが書き込み可能であることを意味するわけではなく、単にパスが利用可能であることを意味する点に注意してください。

解説(Remarks)

この関数の主な用途は、プログラムがパスを使用する前にそのパスを確認し、ユーザーに確認を促すために必要なユーザーインターフェイスを表示することです。たとえば、ドライブ A: のディスクが見つからない場合は、ディスクの挿入をユーザーに促すウィンドウが表示されます。

メモ

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

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

各言語での呼び出し定義

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

HRESULT SHPathPrepareForWriteA(
    HWND hwnd,   // optional
    IUnknown* punkEnableModless,   // optional
    LPCSTR pszPath,
    DWORD dwFlags
);

[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SHPathPrepareForWriteA(
    IntPtr hwnd,   // HWND optional
    IntPtr punkEnableModless,   // IUnknown* optional
    [MarshalAs(UnmanagedType.LPStr)] string pszPath,   // LPCSTR
    uint dwFlags   // DWORD
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHPathPrepareForWriteA(
    hwnd As IntPtr,   ' HWND optional
    punkEnableModless As IntPtr,   ' IUnknown* optional
    <MarshalAs(UnmanagedType.LPStr)> pszPath As String,   ' LPCSTR
    dwFlags As UInteger   ' DWORD
) As Integer
End Function

' hwnd : HWND optional
' punkEnableModless : IUnknown* optional
' pszPath : LPCSTR
' dwFlags : DWORD
Declare PtrSafe Function SHPathPrepareForWriteA Lib "shell32" ( _
    ByVal hwnd As LongPtr, _
    ByVal punkEnableModless As LongPtr, _
    ByVal pszPath As String, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHPathPrepareForWriteA = ctypes.windll.shell32.SHPathPrepareForWriteA
SHPathPrepareForWriteA.restype = ctypes.c_int
SHPathPrepareForWriteA.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    ctypes.c_void_p,  # punkEnableModless : IUnknown* optional
    wintypes.LPCSTR,  # pszPath : LPCSTR
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHPathPrepareForWriteA = Fiddle::Function.new(
  lib['SHPathPrepareForWriteA'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND optional
    Fiddle::TYPE_VOIDP,  # punkEnableModless : IUnknown* optional
    Fiddle::TYPE_VOIDP,  # pszPath : LPCSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHPathPrepareForWriteA(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        punkEnableModless: *mut core::ffi::c_void,  // IUnknown* optional
        pszPath: *const u8,  // LPCSTR
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern int SHPathPrepareForWriteA(IntPtr hwnd, IntPtr punkEnableModless, [MarshalAs(UnmanagedType.LPStr)] string pszPath, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHPathPrepareForWriteA' -Namespace Win32 -PassThru
# $api::SHPathPrepareForWriteA(hwnd, punkEnableModless, pszPath, dwFlags)

#uselib "SHELL32.dll"
#func global SHPathPrepareForWriteA "SHPathPrepareForWriteA" sptr, sptr, sptr, sptr
; SHPathPrepareForWriteA hwnd, punkEnableModless, pszPath, dwFlags   ; 戻り値は stat
; hwnd : HWND optional -> "sptr"
; punkEnableModless : IUnknown* optional -> "sptr"
; pszPath : LPCSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "SHELL32.dll"
#cfunc global SHPathPrepareForWriteA "SHPathPrepareForWriteA" sptr, sptr, str, int
; res = SHPathPrepareForWriteA(hwnd, punkEnableModless, pszPath, dwFlags)
; hwnd : HWND optional -> "sptr"
; punkEnableModless : IUnknown* optional -> "sptr"
; pszPath : LPCSTR -> "str"
; dwFlags : DWORD -> "int"

; HRESULT SHPathPrepareForWriteA(HWND hwnd, IUnknown* punkEnableModless, LPCSTR pszPath, DWORD dwFlags)
#uselib "SHELL32.dll"
#cfunc global SHPathPrepareForWriteA "SHPathPrepareForWriteA" intptr, intptr, str, int
; res = SHPathPrepareForWriteA(hwnd, punkEnableModless, pszPath, dwFlags)
; hwnd : HWND optional -> "intptr"
; punkEnableModless : IUnknown* optional -> "intptr"
; pszPath : LPCSTR -> "str"
; dwFlags : DWORD -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHPathPrepareForWriteA = shell32.NewProc("SHPathPrepareForWriteA")
)

// hwnd (HWND optional), punkEnableModless (IUnknown* optional), pszPath (LPCSTR), dwFlags (DWORD)
r1, _, err := procSHPathPrepareForWriteA.Call(
	uintptr(hwnd),
	uintptr(punkEnableModless),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszPath))),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT

function SHPathPrepareForWriteA(
  hwnd: THandle;   // HWND optional
  punkEnableModless: Pointer;   // IUnknown* optional
  pszPath: PAnsiChar;   // LPCSTR
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHPathPrepareForWriteA';

result := DllCall("SHELL32\SHPathPrepareForWriteA"
    , "Ptr", hwnd   ; HWND optional
    , "Ptr", punkEnableModless   ; IUnknown* optional
    , "AStr", pszPath   ; LPCSTR
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: HRESULT

●SHPathPrepareForWriteA(hwnd, punkEnableModless, pszPath, dwFlags) = DLL("SHELL32.dll", "int SHPathPrepareForWriteA(void*, void*, char*, dword)")
# 呼び出し: SHPathPrepareForWriteA(hwnd, punkEnableModless, pszPath, dwFlags)
# hwnd : HWND optional -> "void*"
# punkEnableModless : IUnknown* optional -> "void*"
# pszPath : LPCSTR -> "char*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "shell32" fn SHPathPrepareForWriteA(
    hwnd: ?*anyopaque, // HWND optional
    punkEnableModless: ?*anyopaque, // IUnknown* optional
    pszPath: [*c]const u8, // LPCSTR
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;

proc SHPathPrepareForWriteA(
    hwnd: pointer,  # HWND optional
    punkEnableModless: pointer,  # IUnknown* optional
    pszPath: cstring,  # LPCSTR
    dwFlags: uint32  # DWORD
): int32 {.importc: "SHPathPrepareForWriteA", stdcall, dynlib: "SHELL32.dll".}

pragma(lib, "shell32");
extern(Windows)
int SHPathPrepareForWriteA(
    void* hwnd,   // HWND optional
    void* punkEnableModless,   // IUnknown* optional
    const(char)* pszPath,   // LPCSTR
    uint dwFlags   // DWORD
);

ccall((:SHPathPrepareForWriteA, "SHELL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Cstring, UInt32),
      hwnd, punkEnableModless, pszPath, dwFlags)
# hwnd : HWND optional -> Ptr{Cvoid}
# punkEnableModless : IUnknown* optional -> Ptr{Cvoid}
# pszPath : LPCSTR -> Cstring
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t SHPathPrepareForWriteA(
    void* hwnd,
    void* punkEnableModless,
    const char* pszPath,
    uint32_t dwFlags);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHPathPrepareForWriteA(hwnd, punkEnableModless, pszPath, dwFlags)
-- hwnd : HWND optional
-- punkEnableModless : IUnknown* optional
-- pszPath : LPCSTR
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHPathPrepareForWriteA = lib.func('__stdcall', 'SHPathPrepareForWriteA', 'int32_t', ['void *', 'void *', 'str', 'uint32_t']);
// SHPathPrepareForWriteA(hwnd, punkEnableModless, pszPath, dwFlags)
// hwnd : HWND optional -> 'void *'
// punkEnableModless : IUnknown* optional -> 'void *'
// pszPath : LPCSTR -> 'str'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("SHELL32.dll", {
  SHPathPrepareForWriteA: { parameters: ["pointer", "pointer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.SHPathPrepareForWriteA(hwnd, punkEnableModless, pszPath, dwFlags)
// hwnd : HWND optional -> "pointer"
// punkEnableModless : IUnknown* optional -> "pointer"
// pszPath : LPCSTR -> "buffer"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t SHPathPrepareForWriteA(
    void* hwnd,
    void* punkEnableModless,
    const char* pszPath,
    uint32_t dwFlags);
C, "SHELL32.dll");
// $ffi->SHPathPrepareForWriteA(hwnd, punkEnableModless, pszPath, dwFlags);
// hwnd : HWND optional
// punkEnableModless : IUnknown* optional
// pszPath : LPCSTR
// 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.ASCII_OPTIONS);
    int SHPathPrepareForWriteA(
        Pointer hwnd,   // HWND optional
        Pointer punkEnableModless,   // IUnknown* optional
        String pszPath,   // LPCSTR
        int dwFlags   // DWORD
    );
}

@[Link("shell32")]
lib LibSHELL32
  fun SHPathPrepareForWriteA = SHPathPrepareForWriteA(
    hwnd : Void*,   # HWND optional
    punkEnableModless : Void*,   # IUnknown* optional
    pszPath : UInt8*,   # LPCSTR
    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 SHPathPrepareForWriteANative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>, Uint32);
typedef SHPathPrepareForWriteADart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>, int);
final SHPathPrepareForWriteA = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHPathPrepareForWriteANative, SHPathPrepareForWriteADart>('SHPathPrepareForWriteA');
// hwnd : HWND optional -> Pointer<Void>
// punkEnableModless : IUnknown* optional -> Pointer<Void>
// pszPath : LPCSTR -> Pointer<Utf8>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function SHPathPrepareForWriteA(
  hwnd: THandle;   // HWND optional
  punkEnableModless: Pointer;   // IUnknown* optional
  pszPath: PAnsiChar;   // LPCSTR
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHPathPrepareForWriteA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHPathPrepareForWriteA"
  c_SHPathPrepareForWriteA :: Ptr () -> Ptr () -> CString -> Word32 -> IO Int32
-- hwnd : HWND optional -> Ptr ()
-- punkEnableModless : IUnknown* optional -> Ptr ()
-- pszPath : LPCSTR -> CString
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let shpathprepareforwritea =
  foreign "SHPathPrepareForWriteA"
    ((ptr void) @-> (ptr void) @-> string @-> uint32_t @-> returning int32_t)
(* hwnd : HWND optional -> (ptr void) *)
(* punkEnableModless : IUnknown* optional -> (ptr void) *)
(* pszPath : LPCSTR -> string *)
(* 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 ("SHPathPrepareForWriteA" shpath-prepare-for-write-a :convention :stdcall) :int32
  (hwnd :pointer)   ; HWND optional
  (punk-enable-modless :pointer)   ; IUnknown* optional
  (psz-path :string)   ; LPCSTR
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $SHPathPrepareForWriteA = Win32::API::More->new('SHELL32',
    'int SHPathPrepareForWriteA(HANDLE hwnd, LPVOID punkEnableModless, LPCSTR pszPath, DWORD dwFlags)');
# my $ret = $SHPathPrepareForWriteA->Call($hwnd, $punkEnableModless, $pszPath, $dwFlags);
# hwnd : HWND optional -> HANDLE
# punkEnableModless : IUnknown* optional -> LPVOID
# pszPath : LPCSTR -> LPCSTR
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

SHPathPrepareForWriteA

シグネチャ

パラメーター

SHPPFW_NONE

SHPPFW_DEFAULT

SHPPFW_DIRCREATE

SHPPFW_ASKDIRCREATE

SHPPFW_IGNOREFILENAME

SHPPFW_NOWRITECHECK

SHPPFW_MEDIACHECKONLY

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目