Win32 API 日本語リファレンス
ホームUI.Shell › SHFileOperationA

SHFileOperationA

関数
ファイルのコピー・移動・削除・名前変更を実行する。
DLLSHELL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

INT SHFileOperationA(
    SHFILEOPSTRUCTA* lpFileOp
);

パラメーター

名前方向説明
lpFileOpSHFILEOPSTRUCTA*inoutこの関数が指定された操作を実行するために必要な情報を含む SHFILEOPSTRUCT 構造体へのポインターです。このパラメーターには NULL ではない有効な値を指定する必要があります。値の検証は呼び出し側の責任です。検証を行わない場合、予期しない結果が生じます。

戻り値の型: INT

公式ドキュメント

ファイルシステムオブジェクトのコピー、移動、名前変更、または削除を行います。この関数は Windows Vista では IFileOperation に置き換えられています。

戻り値

型: int

成功した場合は 0 を返します。それ以外の場合は 0 以外の値を返します。通常、アプリケーションは 0 か 0 以外かを確認するだけで十分です。

SHFILEOPSTRUCTfAnyOperationsAborted メンバーの値も確認することを推奨します。ユーザーが操作をキャンセルした場合でも、SHFileOperation は成功として 0 を返すことがあります。戻り値に加えて fAnyOperationsAborted を確認しないと、要求したタスクが完全に実行されたかどうかを知ることができず、誤った前提のもとで処理を続行してしまう可能性があります。

この関数の戻り値に対して GetLastError を使用しないでください。

トラブルシューティングのために 0 以外の値を調べる場合、それらの多くは Winerror.h で定義されている値に対応します。ただし、戻り値の中には Win32 以前のエラーコードに基づくものがいくつかあり、それらは Winerror.h の後発の値と数値が重複しながらも意味が一致しない場合があります。該当する値についてはここで詳述しており、これらの特定の値に限り、Winerror.h のコードよりもここで示す意味を優先してください。ただし、これらの値には次の注意事項が伴います。

エラーコード 意味
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_PERSONALCSIDL_DOCUMENTS)と マイ ピクチャ フォルダー(CSIDL_MYPICTURES)です。

ファイルの削除に使用した場合、lpFileOp が指す SHFILEOPSTRUCT 構造体の fFlags メンバーに FOF_ALLOWUNDO フラグを設定しない限り、SHFileOperation はファイルを完全に削除します。このフラグを設定すると、ファイルはごみ箱に送られます。単にファイルを削除し、ごみ箱に入れないことを確実にしたい場合は、DeleteFile を使用してください。

コピーコールバックハンドラーが公開され登録されている場合、lpFileOp が指す構造体の fFlags メンバーに FOF_NOCONFIRMATION などのフラグを設定しない限り、SHFileOperation はそれを呼び出します。コピーコールバックハンドラーの実装の詳細については、ICopyHook::CopyCallback を参照してください。

lpFileOpFOF_NORECURSION フラグを設定しない限り、ファイルの削除は再帰的に行われます。

ファイルの関連付け

Windows 2000 以降では、HTML ファイルを、Graphics Interchange Format (GIF) 画像やスタイルシートなどの関連ファイルを含むフォルダーと 関連付ける ことができます。ファイルの関連付けが有効になっている場合、HTML ファイルを移動またはコピーすると、関連付けられたフォルダーとそのすべてのファイルも一緒に移動またはコピーされます。逆に、関連ファイルを含むフォルダーを移動すると、HTML ファイルも一緒に移動されます。

HTML ファイルの拡張子は .htm または .html である必要があります。関連ファイルへの関連付けは、それらを含むフォルダーを HTML ファイルと同じフォルダーに配置することで作成します。関連ファイルを含むフォルダーの名前は、HTML ファイルの名前の後に "_files" または ".files" を付けたものと同じである必要があります(これは大文字と小文字を区別します。たとえば ".Files" は機能しません)。以下に例を示します。

  1. C:\Files ディレクトリに Test.htm という名前のファイルを作成します(C:\Files\Test.htm)。
  2. C:\Files ディレクトリに Test.files という名前の新しいフォルダーを作成します(C:\Files\Test.files)。
  3. このフォルダーにいくつかのファイルを配置します。このフォルダーに配置されたファイルは Test.htm に関連付けられます。
  4. Test.htm ファイルを C:\Files2 ディレクトリに移動またはコピーします。
  5. Test.files ディレクトリも C:\Files2 ディレクトリ内に存在するようになっていることを確認します。

ファイルの関連付けは既定で有効になっています。次に示すように REG_DWORD エントリ NoFileFolderConnection を追加することで無効にできます。

HKEY_CURRENT_USER
   Software
      Microsoft
         Windows
            CurrentVersion
               Explorer
                  NoFileFolderConnection

NoFileFolderConnection を 1 に設定すると、ファイルの関連付けが無効になります。値が 0 に設定されているか存在しない場合、ファイルの関連付けは有効になります。

指定したファイルのみを移動し、関連付けられたファイルを移動しないようにするには、lpFileOp が指す構造体の fFlags メンバーに FOF_NO_CONNECTED_ELEMENTS フラグを設定します。

なお、"MyFile_files" のような名前のフォルダーを使って関連付けを定義する方法は、ローカライズ版の Windows では有効でない場合があります。"files" という語を、ローカル言語の同等の語に置き換える必要があるかもしれません。

メモ

shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHFileOperation を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーになる可能性があります。詳細については、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>

INT SHFileOperationA(
    SHFILEOPSTRUCTA* lpFileOp
);
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int SHFileOperationA(
    IntPtr lpFileOp   // SHFILEOPSTRUCTA* in/out
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SHFileOperationA(
    lpFileOp As IntPtr   ' SHFILEOPSTRUCTA* in/out
) As Integer
End Function
' lpFileOp : SHFILEOPSTRUCTA* in/out
Declare PtrSafe Function SHFileOperationA Lib "shell32" ( _
    ByVal lpFileOp As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHFileOperationA = ctypes.windll.shell32.SHFileOperationA
SHFileOperationA.restype = ctypes.c_int
SHFileOperationA.argtypes = [
    ctypes.c_void_p,  # lpFileOp : SHFILEOPSTRUCTA* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHFileOperationA = Fiddle::Function.new(
  lib['SHFileOperationA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileOp : SHFILEOPSTRUCTA* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHFileOperationA(
        lpFileOp: *mut SHFILEOPSTRUCTA  // SHFILEOPSTRUCTA* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int SHFileOperationA(IntPtr lpFileOp);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHFileOperationA' -Namespace Win32 -PassThru
# $api::SHFileOperationA(lpFileOp)
#uselib "SHELL32.dll"
#func global SHFileOperationA "SHFileOperationA" sptr
; SHFileOperationA varptr(lpFileOp)   ; 戻り値は stat
; lpFileOp : SHFILEOPSTRUCTA* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHFileOperationA "SHFileOperationA" var
; res = SHFileOperationA(lpFileOp)
; lpFileOp : SHFILEOPSTRUCTA* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT SHFileOperationA(SHFILEOPSTRUCTA* lpFileOp)
#uselib "SHELL32.dll"
#cfunc global SHFileOperationA "SHFileOperationA" var
; res = SHFileOperationA(lpFileOp)
; lpFileOp : SHFILEOPSTRUCTA* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHFileOperationA = shell32.NewProc("SHFileOperationA")
)

// lpFileOp (SHFILEOPSTRUCTA* in/out)
r1, _, err := procSHFileOperationA.Call(
	uintptr(lpFileOp),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function SHFileOperationA(
  lpFileOp: Pointer   // SHFILEOPSTRUCTA* in/out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHFileOperationA';
result := DllCall("SHELL32\SHFileOperationA"
    , "Ptr", lpFileOp   ; SHFILEOPSTRUCTA* in/out
    , "Int")   ; return: INT
●SHFileOperationA(lpFileOp) = DLL("SHELL32.dll", "int SHFileOperationA(void*)")
# 呼び出し: SHFileOperationA(lpFileOp)
# lpFileOp : SHFILEOPSTRUCTA* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn SHFileOperationA(
    lpFileOp: [*c]SHFILEOPSTRUCTA // SHFILEOPSTRUCTA* in/out
) callconv(std.os.windows.WINAPI) i32;
proc SHFileOperationA(
    lpFileOp: ptr SHFILEOPSTRUCTA  # SHFILEOPSTRUCTA* in/out
): int32 {.importc: "SHFileOperationA", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int SHFileOperationA(
    SHFILEOPSTRUCTA* lpFileOp   // SHFILEOPSTRUCTA* in/out
);
ccall((:SHFileOperationA, "SHELL32.dll"), stdcall, Int32,
      (Ptr{SHFILEOPSTRUCTA},),
      lpFileOp)
# lpFileOp : SHFILEOPSTRUCTA* in/out -> Ptr{SHFILEOPSTRUCTA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHFileOperationA(
    void* lpFileOp);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHFileOperationA(lpFileOp)
-- lpFileOp : SHFILEOPSTRUCTA* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHFileOperationA = lib.func('__stdcall', 'SHFileOperationA', 'int32_t', ['void *']);
// SHFileOperationA(lpFileOp)
// lpFileOp : SHFILEOPSTRUCTA* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHFileOperationA: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.SHFileOperationA(lpFileOp)
// lpFileOp : SHFILEOPSTRUCTA* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHFileOperationA(
    void* lpFileOp);
C, "SHELL32.dll");
// $ffi->SHFileOperationA(lpFileOp);
// lpFileOp : SHFILEOPSTRUCTA* 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.ASCII_OPTIONS);
    int SHFileOperationA(
        Pointer lpFileOp   // SHFILEOPSTRUCTA* in/out
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHFileOperationA = SHFileOperationA(
    lpFileOp : SHFILEOPSTRUCTA*   # SHFILEOPSTRUCTA* 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 SHFileOperationANative = Int32 Function(Pointer<Void>);
typedef SHFileOperationADart = int Function(Pointer<Void>);
final SHFileOperationA = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHFileOperationANative, SHFileOperationADart>('SHFileOperationA');
// lpFileOp : SHFILEOPSTRUCTA* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHFileOperationA(
  lpFileOp: Pointer   // SHFILEOPSTRUCTA* in/out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHFileOperationA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHFileOperationA"
  c_SHFileOperationA :: Ptr () -> IO Int32
-- lpFileOp : SHFILEOPSTRUCTA* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shfileoperationa =
  foreign "SHFileOperationA"
    ((ptr void) @-> returning int32_t)
(* lpFileOp : SHFILEOPSTRUCTA* 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 ("SHFileOperationA" shfile-operation-a :convention :stdcall) :int32
  (lp-file-op :pointer))   ; SHFILEOPSTRUCTA* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHFileOperationA = Win32::API::More->new('SHELL32',
    'int SHFileOperationA(LPVOID lpFileOp)');
# my $ret = $SHFileOperationA->Call($lpFileOp);
# lpFileOp : SHFILEOPSTRUCTA* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型