SHFileOperationW
関数シグネチャ
// SHELL32.dll (Unicode / -W)
#include <windows.h>
INT SHFileOperationW(
SHFILEOPSTRUCTW* lpFileOp
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpFileOp | SHFILEOPSTRUCTW* | inout | この関数が指定された操作を実行するために必要な情報を格納した SHFILEOPSTRUCT 構造体へのポインターです。このパラメーターには NULL 以外の有効な値を指定する必要があります。値の検証は呼び出し側の責任です。検証を行わない場合、予期しない結果が発生します。 |
戻り値の型: INT
公式ドキュメント
ファイルシステムオブジェクトをコピー、移動、名前変更、または削除します。Windows Vista 以降のリリースでは、この関数の代わりに IFileOperation を使用することをお勧めします。
戻り値
型: int
成功した場合はゼロを返します。それ以外の場合はゼロ以外を返します。通常、アプリケーションは単にゼロかゼロ以外かをチェックするだけで十分です。
SHFILEOPSTRUCT の fAnyOperationsAborted メンバーの値を確認することをお勧めします。SHFileOperation は、ユーザーが操作をキャンセルした場合でも成功として 0 を返すことがあります。戻り値だけでなく fAnyOperationsAborted も確認しないと、要求した処理が完全に達成されたかどうかを知ることができず、誤った前提のまま処理を進めてしまう可能性があります。
この関数の戻り値に対して GetLastError を使用しないでください。
トラブルシューティングのためにゼロ以外の値を調べる場合、それらの値の大部分は Winerror.h で定義されている値に対応します。ただし、いくつかの戻り値は Win32 以前のエラーコードに基づいており、場合によっては後の Winerror.h の値と数値が重複しているにもかかわらず意味が一致しないことがあります。それらの特定の値についてはここで詳しく説明しており、これらの特定の値に限り、Winerror.h のコードよりもここで示す意味を優先すべきです。ただし、これらの値については以下の注意事項が伴います。
- これらは Win32 以前のエラーコードであり、もはやサポートされておらず、いかなる公開ヘッダーファイルでも定義されていません。これらを使用するには、自分で定義するか、数値と直接比較する必要があります。
- これらのエラーコードは変更される可能性があり、歴史的に実際に変更されてきました。
- これらの値はデバッグの補助としてのみ提供されています。確定的なものとみなすべきではありません。
| エラーコード | 値 | 意味 |
|---|---|---|
| DE_SAMEFILE | 0x71 | コピー元とコピー先のファイルが同一のファイルです。 |
| DE_MANYSRC1DEST | 0x72 | コピー元バッファーに複数のファイルパスが指定されていますが、コピー先のファイルパスは 1 つだけです。 |
| DE_DIFFDIR | 0x73 | 名前変更操作が指定されましたが、コピー先のパスが別のディレクトリです。代わりに移動操作を使用してください。 |
| DE_ROOTDIR | 0x74 | コピー元がルートディレクトリであり、移動または名前変更できません。 |
| DE_OPCANCELLED | 0x75 | 操作がユーザーによってキャンセルされたか、適切なフラグが SHFileOperation に渡された場合は通知なしにキャンセルされました。 |
| DE_DESTSUBTREE | 0x76 | コピー先がコピー元のサブツリーです。 |
| DE_ACCESSDENIEDSRC | 0x78 | セキュリティ設定によってコピー元へのアクセスが拒否されました。 |
| DE_PATHTOODEEP | 0x79 | コピー元またはコピー先のパスが MAX_PATH を超えたか、超える見込みです。 |
| DE_MANYDEST | 0x7A | 操作に複数のコピー先パスが含まれており、移動操作の場合に失敗することがあります。 |
| DE_INVALIDFILES | 0x7C | コピー元もしくはコピー先、またはその両方のパスが無効です。 |
| DE_DESTSAMETREE | 0x7D | コピー元とコピー先が同じ親フォルダーを持っています。 |
| DE_FLDDESTISFILE | 0x7E | コピー先のパスが既存のファイルです。 |
| DE_FILEDESTISFLD | 0x80 | コピー先のパスが既存のフォルダーです。 |
| DE_FILENAMETOOLONG | 0x81 | ファイル名が MAX_PATH を超えています。 |
| DE_DEST_IS_CDROM | 0x82 | コピー先が読み取り専用の CD-ROM であり、未フォーマットの可能性があります。 |
| DE_DEST_IS_DVD | 0x83 | コピー先が読み取り専用の DVD であり、未フォーマットの可能性があります。 |
| DE_DEST_IS_CDRECORD | 0x84 | コピー先が書き込み可能な CD-ROM であり、未フォーマットの可能性があります。 |
| DE_FILE_TOO_LARGE | 0x85 | 操作に関係するファイルが、コピー先のメディアまたはファイルシステムには大きすぎます。 |
| DE_SRC_IS_CDROM | 0x86 | コピー元が読み取り専用の CD-ROM であり、未フォーマットの可能性があります。 |
| DE_SRC_IS_DVD | 0x87 | コピー元が読み取り専用の DVD であり、未フォーマットの可能性があります。 |
| DE_SRC_IS_CDRECORD | 0x88 | コピー元が書き込み可能な CD-ROM であり、未フォーマットの可能性があります。 |
| DE_ERROR_MAX | 0xB7 | 操作中に MAX_PATH を超えました。 |
| 0x402 | 不明なエラーが発生しました。これは通常、コピー元またはコピー先のパスが無効であることが原因です。このエラーは Windows Vista 以降では発生しません。 | |
| ERRORONDEST | 0x10000 | コピー先で原因不明のエラーが発生しました。 |
| DE_ROOTDIR | ERRORONDEST | 0x10074 | コピー先がルートディレクトリであり、名前変更できません。 |
解説(Remarks)
この関数では完全修飾パス名を使用してください。相対パス名を使用した場合、スレッドセーフではありません。
2 つの例外を除き、SHFileOperation を使用してネットワークパスを指定することで、特殊フォルダーをローカルドライブからリモートコンピューターへ移動することはできません。例外となるのは、マイ ドキュメント(CSIDL_PERSONAL、CSIDL_DOCUMENTS)と マイ ピクチャ フォルダー(CSIDL_MYPICTURES)です。
ファイルの削除に使用する場合、lpFileOp が指す SHFILEOPSTRUCT 構造体の fFlags メンバーに FOF_ALLOWUNDO フラグを設定しない限り、SHFileOperation はファイルを完全に削除します。このフラグを設定すると、ファイルはごみ箱に送られます。単にファイルを削除し、ごみ箱に置かれないことを保証したい場合は、DeleteFile を使用してください。
コピーコールバックハンドラーが公開され登録されている場合、lpFileOp が指す構造体の fFlags メンバーに FOF_NOCONFIRMATION などのフラグを設定しない限り、SHFileOperation はそれを呼び出します。コピーコールバックハンドラーの実装の詳細については、ICopyHook::CopyCallback を参照してください。
ファイルの削除は、lpFileOp に FOF_NORECURSION フラグを設定しない限り再帰的に行われます。
ファイルの関連付け
Windows 2000 以降では、HTML ファイルを、Graphics Interchange Format (GIF) 画像やスタイルシートなどの関連ファイルを含むフォルダーと関連付けることができます。ファイルの関連付けが有効になっている場合、HTML ファイルを移動またはコピーすると、関連付けられたフォルダーとそのすべてのファイルも移動またはコピーされます。逆に、関連ファイルを含むフォルダーを移動すると、HTML ファイルも移動されます。HTML ファイルには .htm または .html 拡張子が必要です。関連ファイルへの関連付けは、それらを含むフォルダーを HTML ファイルと同じフォルダーに配置することで作成します。関連付けられたファイルを含むフォルダーの名前は、HTML ファイルの名前の後に "_files" または ".files" を付けたものと同じである必要があります(これは大文字と小文字を区別します。たとえば ".Files" は機能しません)。以下に例を示します。
- C:\Files ディレクトリに Test.htm という名前のファイルを作成します(C:\Files\Test.htm)。
- C:\Files ディレクトリに Test.files という名前の新しいフォルダーを作成します(C:\Files\Test.files)。
- このフォルダーにいくつかのファイルを配置します。このフォルダーに配置されたファイルはすべて Test.htm に関連付けられます。
- Test.htm ファイルを C:\Files2 ディレクトリへ移動またはコピーします。
- Test.files ディレクトリも C:\Files2 ディレクトリ内に存在するようになっていることを確認します。
ファイルの関連付けは既定で有効です。以下のように REG_DWORD エントリ NoFileFolderConnection を追加することで無効にできます。
HKEY_CURRENT_USER
Software
Microsoft
Windows
CurrentVersion
Explorer
NoFileFolderConnection
NoFileFolderConnection を 1 に設定するとファイルの関連付けが無効になります。値がゼロに設定されているか、存在しない場合は、ファイルの関連付けが有効になります。
指定したファイルのみを移動し、関連付けられたファイルを一切移動しないようにするには、lpFileOp が指す構造体の fFlags メンバーに FOF_NO_CONNECTED_ELEMENTS フラグを設定します。
なお、"MyFile_files" のような名前のフォルダーを使用して関連付けを定義する方法は、ローカライズ版の Windows では有効でない場合があります。"files" という語を、現地語での同等の単語に置き換える必要がある場合があります。
shellapi.h ヘッダーは、SHFileOperation を、UNICODE プリプロセッサ定数の定義に基づいて ANSI 版または Unicode 版のいずれかを自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHELL32.dll (Unicode / -W)
#include <windows.h>
INT SHFileOperationW(
SHFILEOPSTRUCTW* lpFileOp
);[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int SHFileOperationW(
IntPtr lpFileOp // SHFILEOPSTRUCTW* in/out
);<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SHFileOperationW(
lpFileOp As IntPtr ' SHFILEOPSTRUCTW* in/out
) As Integer
End Function' lpFileOp : SHFILEOPSTRUCTW* in/out
Declare PtrSafe Function SHFileOperationW Lib "shell32" ( _
ByVal lpFileOp 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
SHFileOperationW = ctypes.windll.shell32.SHFileOperationW
SHFileOperationW.restype = ctypes.c_int
SHFileOperationW.argtypes = [
ctypes.c_void_p, # lpFileOp : SHFILEOPSTRUCTW* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHELL32.dll')
SHFileOperationW = Fiddle::Function.new(
lib['SHFileOperationW'],
[
Fiddle::TYPE_VOIDP, # lpFileOp : SHFILEOPSTRUCTW* in/out
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shell32")]
extern "system" {
fn SHFileOperationW(
lpFileOp: *mut SHFILEOPSTRUCTW // SHFILEOPSTRUCTW* in/out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int SHFileOperationW(IntPtr lpFileOp);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHFileOperationW' -Namespace Win32 -PassThru
# $api::SHFileOperationW(lpFileOp)#uselib "SHELL32.dll"
#func global SHFileOperationW "SHFileOperationW" wptr
; SHFileOperationW varptr(lpFileOp) ; 戻り値は stat
; lpFileOp : SHFILEOPSTRUCTW* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHELL32.dll" #cfunc global SHFileOperationW "SHFileOperationW" var ; res = SHFileOperationW(lpFileOp) ; lpFileOp : SHFILEOPSTRUCTW* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll" #cfunc global SHFileOperationW "SHFileOperationW" sptr ; res = SHFileOperationW(varptr(lpFileOp)) ; lpFileOp : SHFILEOPSTRUCTW* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; INT SHFileOperationW(SHFILEOPSTRUCTW* lpFileOp) #uselib "SHELL32.dll" #cfunc global SHFileOperationW "SHFileOperationW" var ; res = SHFileOperationW(lpFileOp) ; lpFileOp : SHFILEOPSTRUCTW* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT SHFileOperationW(SHFILEOPSTRUCTW* lpFileOp) #uselib "SHELL32.dll" #cfunc global SHFileOperationW "SHFileOperationW" intptr ; res = SHFileOperationW(varptr(lpFileOp)) ; lpFileOp : SHFILEOPSTRUCTW* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shell32 = windows.NewLazySystemDLL("SHELL32.dll")
procSHFileOperationW = shell32.NewProc("SHFileOperationW")
)
// lpFileOp (SHFILEOPSTRUCTW* in/out)
r1, _, err := procSHFileOperationW.Call(
uintptr(lpFileOp),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction SHFileOperationW(
lpFileOp: Pointer // SHFILEOPSTRUCTW* in/out
): Integer; stdcall;
external 'SHELL32.dll' name 'SHFileOperationW';result := DllCall("SHELL32\SHFileOperationW"
, "Ptr", lpFileOp ; SHFILEOPSTRUCTW* in/out
, "Int") ; return: INT●SHFileOperationW(lpFileOp) = DLL("SHELL32.dll", "int SHFileOperationW(void*)")
# 呼び出し: SHFileOperationW(lpFileOp)
# lpFileOp : SHFILEOPSTRUCTW* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shell32" fn SHFileOperationW(
lpFileOp: [*c]SHFILEOPSTRUCTW // SHFILEOPSTRUCTW* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SHFileOperationW(
lpFileOp: ptr SHFILEOPSTRUCTW # SHFILEOPSTRUCTW* in/out
): int32 {.importc: "SHFileOperationW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shell32");
extern(Windows)
int SHFileOperationW(
SHFILEOPSTRUCTW* lpFileOp // SHFILEOPSTRUCTW* in/out
);ccall((:SHFileOperationW, "SHELL32.dll"), stdcall, Int32,
(Ptr{SHFILEOPSTRUCTW},),
lpFileOp)
# lpFileOp : SHFILEOPSTRUCTW* in/out -> Ptr{SHFILEOPSTRUCTW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t SHFileOperationW(
void* lpFileOp);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHFileOperationW(lpFileOp)
-- lpFileOp : SHFILEOPSTRUCTW* in/out
-- 構造体/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 SHFileOperationW = lib.func('__stdcall', 'SHFileOperationW', 'int32_t', ['void *']);
// SHFileOperationW(lpFileOp)
// lpFileOp : SHFILEOPSTRUCTW* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHELL32.dll", {
SHFileOperationW: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.SHFileOperationW(lpFileOp)
// lpFileOp : SHFILEOPSTRUCTW* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SHFileOperationW(
void* lpFileOp);
C, "SHELL32.dll");
// $ffi->SHFileOperationW(lpFileOp);
// lpFileOp : SHFILEOPSTRUCTW* in/out
// 構造体/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 SHFileOperationW(
Pointer lpFileOp // SHFILEOPSTRUCTW* in/out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shell32")]
lib LibSHELL32
fun SHFileOperationW = SHFileOperationW(
lpFileOp : SHFILEOPSTRUCTW* # SHFILEOPSTRUCTW* in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SHFileOperationWNative = Int32 Function(Pointer<Void>);
typedef SHFileOperationWDart = int Function(Pointer<Void>);
final SHFileOperationW = DynamicLibrary.open('SHELL32.dll')
.lookupFunction<SHFileOperationWNative, SHFileOperationWDart>('SHFileOperationW');
// lpFileOp : SHFILEOPSTRUCTW* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHFileOperationW(
lpFileOp: Pointer // SHFILEOPSTRUCTW* in/out
): Integer; stdcall;
external 'SHELL32.dll' name 'SHFileOperationW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHFileOperationW"
c_SHFileOperationW :: Ptr () -> IO Int32
-- lpFileOp : SHFILEOPSTRUCTW* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shfileoperationw =
foreign "SHFileOperationW"
((ptr void) @-> returning int32_t)
(* lpFileOp : SHFILEOPSTRUCTW* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)
(cffi:defcfun ("SHFileOperationW" shfile-operation-w :convention :stdcall) :int32
(lp-file-op :pointer)) ; SHFILEOPSTRUCTW* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHFileOperationW = Win32::API::More->new('SHELL32',
'int SHFileOperationW(LPVOID lpFileOp)');
# my $ret = $SHFileOperationW->Call($lpFileOp);
# lpFileOp : SHFILEOPSTRUCTW* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f SHFileOperationA (ANSI版) — ファイルのコピー・移動・削除・名前変更を実行する。