Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Support Forum
Download Visual Studio Add-In

Terms of Use
Privacy Policy
SHFileOperation (shell32)
 
.
Summary

C# Signature:

[DllImport("shell32.dll",CharSet = CharSet.Unicode)]
static extern int SHFileOperation([In] ref SHFILEOPSTRUCT lpFileOp);

VB.NET Signature:

<DllImport("shell32.dll", SetLastError:=true, CharSet:=CharSet.Unicode)> _
Public Function SHFileOperation(<MarshalAs(UnmanagedType.Struct)>ByRef lpFileOp As SHFILEOPSTRUCT) As Integer
End function

VB Signature

Public Declare Function SHFileOperation Lib "shell32" Alias "SHFileOperationA" _
        (lpFileOp As SHFILEOPSTRUCT) As Long

User-Defined Types:

SHFILEOPSTRUCT

Notes:

Do not use GetLastError with the return values of this function.

Tips & Tricks:

I tried to use this to send files to the recycle bin. It failed (Marshal.GetLastWin32Error was 6, invalid handle) and sometimes threw a NullReferenceException. To make it work I did the following;

    public IntPtr pFrom;
    public IntPtr pTo;

  • Always set hwnd to my main app window (I was using IntPtr.Zero, this might not be required)
  • Correctly treat pTo and pFrom as zero delimited double zero terminated.

In my case I only needed pTo so I just added a null byte to the end and used Marshal.StringToHGlobalUni() to set the value

    string path = @"c:\one\file.txt";
    info.pTo = Marshal.StringToHGlobalUni(path + '\0');

  • The SHFILEOPSTRUCT StructLayout attribute needs a Pack=2 (win32 - see this in the example) and Pack=8 (win64) parameter. Without it, it does not work. Of course both cannot be set for the same struct, so 2 structs are needed.

Sample Code:

using System.Runtime.InteropServices;

public class InteropSHFileOperation
{
    public enum FO_Func : uint
    {
        FO_MOVE = 0x0001,
        FO_COPY = 0x0002,
        FO_DELETE = 0x0003,
        FO_RENAME = 0x0004,
    }

    [StructLayout(LayoutKind.Sequential, CharSet=CharSet.Unicode, Pack=2)]
    struct SHFILEOPSTRUCT
    {
        public IntPtr hwnd;
        public FO_Func wFunc;
        [MarshalAs(UnmanagedType.LPWStr)]
        public string pFrom;
        [MarshalAs(UnmanagedType.LPWStr)]
        public string pTo;
        public ushort fFlags;
        [MarshalAs(UnmanagedType.Bool)]
        public bool fAnyOperationsAborted;
        public IntPtr hNameMappings;
        [MarshalAs(UnmanagedType.LPWStr)]
        public string lpszProgressTitle;

    }

    [DllImport("shell32.dll",  CharSet = CharSet.Unicode)]
    static extern int SHFileOperation([In, Out] ref SHFILEOPSTRUCT lpFileOp);

    private SHFILEOPSTRUCT _ShFile;
    public FILEOP_FLAGS fFlags;

    public IntPtr hwnd
    {
        set
        {
            this._ShFile.hwnd = value;
        }
    }
    public FO_Func wFunc
    {
        set
        {
            this._ShFile.wFunc = value;
        }
    }

    public string pFrom
    {
        set
        {
            this._ShFile.pFrom = value + '\0' + '\0';
        }
    }
    public string pTo
    {
        set
        {
            this._ShFile.pTo = value + '\0' + '\0';
        }
    }

    public bool fAnyOperationsAborted
    {
        set
        {
            this._ShFile.fAnyOperationsAborted = value;
        }
    }
    public IntPtr hNameMappings
    {
        set
        {
            this._ShFile.hNameMappings = value;
        }
    }
    public string lpszProgressTitle
    {
        set
        {
            this._ShFile.lpszProgressTitle = value + '\0';
        }
    }

    public InteropSHFileOperation()
    {

        this.fFlags = new FILEOP_FLAGS();
        this._ShFile = new SHFILEOPSTRUCT();
        this._ShFile.hwnd = IntPtr.Zero;
        this._ShFile.wFunc = FO_Func.FO_COPY;
        this._ShFile.pFrom = "";
        this._ShFile.pTo = "";
        this._ShFile.fAnyOperationsAborted = false;
        this._ShFile.hNameMappings = IntPtr.Zero;
        this._ShFile.lpszProgressTitle = "";

    }

    public bool Execute()
    {
        this._ShFile.fFlags = this.fFlags.Flag;
        return SHFileOperation(ref this._ShFile) == 0;//true if no errors
    }

    public class FILEOP_FLAGS
    {
        [Flags]
        private enum FILEOP_FLAGS_ENUM : ushort
        {
            FOF_MULTIDESTFILES = 0x0001,
            FOF_CONFIRMMOUSE = 0x0002,
            FOF_SILENT = 0x0004,  // don't create progress/report
            FOF_RENAMEONCOLLISION = 0x0008,
            FOF_NOCONFIRMATION = 0x0010,  // Don't prompt the user.
            FOF_WANTMAPPINGHANDLE = 0x0020,  // Fill in SHFILEOPSTRUCT.hNameMappings
            // Must be freed using SHFreeNameMappings
            FOF_ALLOWUNDO = 0x0040,
            FOF_FILESONLY = 0x0080,  // on *.*, do only files
            FOF_SIMPLEPROGRESS = 0x0100,  // means don't show names of files
            FOF_NOCONFIRMMKDIR = 0x0200,  // don't confirm making any needed dirs
            FOF_NOERRORUI = 0x0400,  // don't put up error UI
            FOF_NOCOPYSECURITYATTRIBS = 0x0800,  // dont copy NT file Security Attributes
            FOF_NORECURSION = 0x1000,  // don't recurse into directories.
            FOF_NO_CONNECTED_ELEMENTS = 0x2000,  // don't operate on connected elements.
            FOF_WANTNUKEWARNING = 0x4000,  // during delete operation, warn if nuking instead of recycling (partially overrides FOF_NOCONFIRMATION)
            FOF_NORECURSEREPARSE = 0x8000,  // treat reparse points as objects, not containers
        }

        public bool FOF_MULTIDESTFILES = false;
        public bool FOF_CONFIRMMOUSE = false;
        public bool FOF_SILENT = false;
        public bool FOF_RENAMEONCOLLISION = false;
        public bool FOF_NOCONFIRMATION = false;
        public bool FOF_WANTMAPPINGHANDLE = false;
        public bool FOF_ALLOWUNDO = false;
        public bool FOF_FILESONLY = false;
        public bool FOF_SIMPLEPROGRESS = false;
        public bool FOF_NOCONFIRMMKDIR = false;
        public bool FOF_NOERRORUI = false;
        public bool FOF_NOCOPYSECURITYATTRIBS = false;
        public bool FOF_NORECURSION = false;
        public bool FOF_NO_CONNECTED_ELEMENTS = false;
        public bool FOF_WANTNUKEWARNING = false;
        public bool FOF_NORECURSEREPARSE = false;

        public ushort Flag
        {
            get
            {
                ushort ReturnValue = 0;

                if ( this.FOF_MULTIDESTFILES )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_MULTIDESTFILES;
                if ( this.FOF_CONFIRMMOUSE )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_CONFIRMMOUSE;
                if ( this.FOF_SILENT )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_SILENT;
                if ( this.FOF_RENAMEONCOLLISION )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_RENAMEONCOLLISION;
                if ( this.FOF_NOCONFIRMATION )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_NOCONFIRMATION;
                if ( this.FOF_WANTMAPPINGHANDLE )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_WANTMAPPINGHANDLE;
                if ( this.FOF_ALLOWUNDO )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_ALLOWUNDO;
                if ( this.FOF_FILESONLY )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_FILESONLY;
                if ( this.FOF_SIMPLEPROGRESS )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_SIMPLEPROGRESS;
                if ( this.FOF_NOCONFIRMMKDIR )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_NOCONFIRMMKDIR;
                if ( this.FOF_NOERRORUI )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_NOERRORUI;
                if ( this.FOF_NOCOPYSECURITYATTRIBS )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_NOCOPYSECURITYATTRIBS;
                if ( this.FOF_NORECURSION )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_NORECURSION;
                if ( this.FOF_NO_CONNECTED_ELEMENTS )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_NO_CONNECTED_ELEMENTS;
                if ( this.FOF_WANTNUKEWARNING )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_WANTNUKEWARNING;
                if ( this.FOF_NORECURSEREPARSE )
                    ReturnValue |= (ushort)FILEOP_FLAGS_ENUM.FOF_NORECURSEREPARSE;

                return ReturnValue;
            }
        }
    }

}

Alternative Managed API:

Microsoft.VisualBasic.FileIO.FileSystem.DeleteFile(string, Microsoft.VisualBasic.FileIO.UIOption, Microsoft.VisualBasic.FileIO.RecycleOption);

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions