recyclebin.c File Reference

#include "recyclebin_private.h"

Include dependency graph for recyclebin.c:

Go to the source code of this file.

Classes
struct	_BBENUMFILECONTEXT

Typedefs
typedef struct _BBENUMFILECONTEXT	BBENUMFILECONTEXT

Functions
EXTERN_C int WINAPI	PathGetDriveNumberW (_In_ LPCWSTR)
BOOL WINAPI	CloseRecycleBinHandle (IN HDELFILE hDeletedFile)
BOOL WINAPI	DeleteFileToRecycleBinA (IN LPCSTR FileName)
BOOL WINAPI	DeleteFileToRecycleBinW (IN LPCWSTR FileName)
BOOL WINAPI	DeleteFileInRecycleBin (IN HDELFILE hDeletedFile)
BOOL WINAPI	EmptyRecycleBinA (IN LPCSTR pszRoot OPTIONAL)
BOOL WINAPI	EmptyRecycleBinW (IN LPCWSTR pszRoot OPTIONAL)
BOOL WINAPI	EnumerateRecycleBinA (IN LPCSTR pszRoot OPTIONAL, IN PENUMERATE_RECYCLEBIN_CALLBACK pFnCallback, IN PVOID Context OPTIONAL)
BOOL WINAPI	EnumerateRecycleBinW (IN LPCWSTR pszRoot OPTIONAL, IN PENUMERATE_RECYCLEBIN_CALLBACK pFnCallback, IN PVOID Context OPTIONAL)
static BOOL CALLBACK	GetRecycleBinFileHandleCallback (IN PVOID Context, IN HDELFILE hDeletedFile)
EXTERN_C HDELFILE	GetRecycleBinFileHandle (IN LPCWSTR pszRoot OPTIONAL, IN const RECYCLEBINFILEIDENTITY *pFI)
EXTERN_C BOOL	RemoveFromRecycleBinDatabase (IN const RECYCLEBINFILEIDENTITY *pFI)
BOOL WINAPI	RestoreFileFromRecycleBin (IN HDELFILE hDeletedFile)
EXTERN_C HRESULT	GetDefaultRecycleBin (IN LPCWSTR pszVolume OPTIONAL, OUT IRecycleBin **pprb)
EXTERN_C HRESULT	GetRecycleBinPathFromDriveNumber (UINT Drive, LPWSTR Path)

Typedef Documentation

BBENUMFILECONTEXT

typedef struct _BBENUMFILECONTEXT BBENUMFILECONTEXT

Function Documentation

CloseRecycleBinHandle()

BOOL WINAPI CloseRecycleBinHandle

(

IN HDELFILE

hDeletedFile

)

Definition at line 13 of file recyclebin.c.

{
    IRecycleBinFile *rbf = IRecycleBinFileFromHDELFILE(hDeletedFile);
    HRESULT hr;
 
    TRACE("(%p)\n", hDeletedFile);
 
    hr = IRecycleBinFile_Release(rbf);
    if (SUCCEEDED(hr))
        return TRUE;
    if (HRESULT_FACILITY(hr) == FACILITY_WIN32)
        SetLastError(HRESULT_CODE(hr));
    else
        SetLastError(ERROR_GEN_FAILURE);
    return FALSE;
}

Referenced by CRecycleBinEnum::CBEnumRecycleBin(), GetRecycleBinFileHandleCallback(), and RemoveFromRecycleBinDatabase().

DeleteFileInRecycleBin()

BOOL WINAPI DeleteFileInRecycleBin

(

IN HDELFILE

hDeletedFile

)

Definition at line 94 of file recyclebin.c.

{
    IRecycleBinFile *rbf = IRecycleBinFileFromHDELFILE(hDeletedFile);
    HRESULT hr;
 
    TRACE("(%p)\n", hDeletedFile);
 
    hr = IRecycleBinFile_Delete(rbf);
 
    if (SUCCEEDED(hr))
        return TRUE;
    if (HRESULT_FACILITY(hr) == FACILITY_WIN32)
        SetLastError(HRESULT_CODE(hr));
    else
        SetLastError(ERROR_GEN_FAILURE);
    return FALSE;
}

DeleteFileToRecycleBinA()

BOOL WINAPI DeleteFileToRecycleBinA

(

IN LPCSTR

FileName

)

Definition at line 32 of file recyclebin.c.

{
    int len;
    LPWSTR FileNameW = NULL;
    BOOL ret = FALSE;
 
    TRACE("(%s)\n", debugstr_a(FileName));
 
    /* Check parameters */
    if (FileName == NULL)
    {
        SetLastError(ERROR_INVALID_PARAMETER);
        goto cleanup;
    }
 
    len = MultiByteToWideChar(CP_ACP, 0, FileName, -1, NULL, 0);
    if (len == 0)
        goto cleanup;
    FileNameW = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
    if (!FileNameW)
    {
        SetLastError(ERROR_NOT_ENOUGH_MEMORY);
        goto cleanup;
    }
    if (MultiByteToWideChar(CP_ACP, 0, FileName, -1, FileNameW, len) == 0)
        goto cleanup;
 
    ret = DeleteFileToRecycleBinW(FileNameW);
 
cleanup:
    HeapFree(GetProcessHeap(), 0, FileNameW);
    return ret;
}

DeleteFileToRecycleBinW()

BOOL WINAPI DeleteFileToRecycleBinW

(

IN LPCWSTR

FileName

)

Definition at line 68 of file recyclebin.c.

{
    IRecycleBin *prb;
    HRESULT hr;
 
    TRACE("(%s)\n", debugstr_w(FileName));
 
    hr = GetDefaultRecycleBin(NULL, &prb);
    if (!SUCCEEDED(hr))
        goto cleanup;
 
    hr = IRecycleBin_DeleteFile(prb, FileName);
    IRecycleBin_Release(prb);
 
cleanup:
    if (SUCCEEDED(hr))
        return TRUE;
    if (HRESULT_FACILITY(hr) == FACILITY_WIN32)
        SetLastError(HRESULT_CODE(hr));
    else
        SetLastError(ERROR_GEN_FAILURE);
    return FALSE;
}

Referenced by DeleteFileToRecycleBinA().

EmptyRecycleBinA()

BOOL WINAPI EmptyRecycleBinA

(

IN LPCSTR pszRoot

OPTIONAL

)

Definition at line 114 of file recyclebin.c.

{
    int len;
    LPWSTR szRootW = NULL;
    BOOL ret = FALSE;
 
    TRACE("(%s)\n", debugstr_a(pszRoot));
 
    if (pszRoot)
    {
        len = MultiByteToWideChar(CP_ACP, 0, pszRoot, -1, NULL, 0);
        if (len == 0)
            goto cleanup;
        szRootW = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
        if (!szRootW)
        {
            SetLastError(ERROR_NOT_ENOUGH_MEMORY);
            goto cleanup;
        }
        if (MultiByteToWideChar(CP_ACP, 0, pszRoot, -1, szRootW, len) == 0)
            goto cleanup;
    }
 
    ret = EmptyRecycleBinW(szRootW);
 
cleanup:
    HeapFree(GetProcessHeap(), 0, szRootW);
    return ret;
}

EmptyRecycleBinW()

BOOL WINAPI EmptyRecycleBinW

(

IN LPCWSTR pszRoot

OPTIONAL

)

Definition at line 146 of file recyclebin.c.

{
    IRecycleBin *prb;
    HRESULT hr;
 
    TRACE("(%s)\n", debugstr_w(pszRoot));
 
    hr = GetDefaultRecycleBin(pszRoot, &prb);
    if (!SUCCEEDED(hr))
        goto cleanup;
 
    hr = IRecycleBin_EmptyRecycleBin(prb);
    IRecycleBin_Release(prb);
 
cleanup:
    if (SUCCEEDED(hr))
        return TRUE;
    if (HRESULT_FACILITY(hr) == FACILITY_WIN32)
        SetLastError(HRESULT_CODE(hr));
    else
        SetLastError(ERROR_GEN_FAILURE);
    return FALSE;
}

Referenced by EmptyRecycleBinA(), and SHEmptyRecycleBinW().

EnumerateRecycleBinA()

BOOL WINAPI EnumerateRecycleBinA	(	IN LPCSTR pszRoot	OPTIONAL,
		IN PENUMERATE_RECYCLEBIN_CALLBACK	pFnCallback,
		IN PVOID Context	OPTIONAL
	)

Definition at line 172 of file recyclebin.c.

{
    int len;
    LPWSTR szRootW = NULL;
    BOOL ret = FALSE;
 
    TRACE("(%s, %p, %p)\n", debugstr_a(pszRoot), pFnCallback, Context);
 
    if (pszRoot)
    {
        len = MultiByteToWideChar(CP_ACP, 0, pszRoot, -1, NULL, 0);
        if (len == 0)
            goto cleanup;
        szRootW = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
        if (!szRootW)
        {
            SetLastError(ERROR_NOT_ENOUGH_MEMORY);
            goto cleanup;
        }
        if (MultiByteToWideChar(CP_ACP, 0, pszRoot, -1, szRootW, len) == 0)
            goto cleanup;
    }
 
    ret = EnumerateRecycleBinW(szRootW, pFnCallback, Context);
 
cleanup:
    HeapFree(GetProcessHeap(), 0, szRootW);
    return ret;
}

EnumerateRecycleBinW()

BOOL WINAPI EnumerateRecycleBinW	(	IN LPCWSTR pszRoot	OPTIONAL,
		IN PENUMERATE_RECYCLEBIN_CALLBACK	pFnCallback,
		IN PVOID Context	OPTIONAL
	)

Definition at line 206 of file recyclebin.c.

{
    IRecycleBin *prb = NULL;
    IRecycleBinEnumList *prbel = NULL;
    IRecycleBinFile *prbf;
    HRESULT hr;
 
    TRACE("(%s, %p, %p)\n", debugstr_w(pszRoot), pFnCallback, Context);
 
    hr = GetDefaultRecycleBin(NULL, &prb);
    if (!SUCCEEDED(hr))
        goto cleanup;
 
    hr = IRecycleBin_EnumObjects(prb, &prbel);
    if (!SUCCEEDED(hr))
        goto cleanup;
    while (TRUE)
    {
        hr = IRecycleBinEnumList_Next(prbel, 1, &prbf, NULL);
        if (hr == S_FALSE)
        {
            hr = S_OK;
            goto cleanup;
        }
        else if (!SUCCEEDED(hr))
            goto cleanup;
        if (!pFnCallback(Context, (HDELFILE)prbf))
        {
            UINT error = GetLastError();
            hr = HRESULT_FROM_WIN32(error);
            goto cleanup;
        }
    }
 
cleanup:
    if (prb)
        IRecycleBin_Release(prb);
    if (prbel)
        IRecycleBinEnumList_Release(prbel);
    if (SUCCEEDED(hr))
        return TRUE;
    if (HRESULT_FACILITY(hr) == FACILITY_WIN32)
        SetLastError(HRESULT_CODE(hr));
    else
        SetLastError(ERROR_GEN_FAILURE);
    return FALSE;
}

Referenced by EnumerateRecycleBinA(), GetRecycleBinFileHandle(), and CRecycleBinEnum::Initialize().

GetDefaultRecycleBin()

EXTERN_C HRESULT GetDefaultRecycleBin	(	IN LPCWSTR pszVolume	OPTIONAL,
		OUT IRecycleBin **	pprb
	)

Definition at line 322 of file recyclebin.c.

{
    IUnknown *pUnk;
    HRESULT hr;
 
    TRACE("(%s, %p)\n", debugstr_w(pszVolume), pprb);
 
    if (!pprb)
        return E_POINTER;
 
    if (!pszVolume)
        hr = RecycleBinGeneric_Constructor(&pUnk);
    else
    {
        WCHAR szRootPath[4] = { *pszVolume, L':', L'\\', UNICODE_NULL };
        int drive = PathGetDriveNumberW(pszVolume);
        if (drive < 0 || pszVolume[2] != L'\\')
            return HRESULT_FROM_WIN32(ERROR_INVALID_NAME);
 
        /* For now, only support this type of recycle bins... */
        hr = RecycleBin5_Constructor(szRootPath, &pUnk);
    }
    if (!SUCCEEDED(hr))
        return hr;
    hr = IUnknown_QueryInterface(pUnk, &IID_IRecycleBin, (void **)pprb);
    IUnknown_Release(pUnk);
    return hr;
}

Referenced by RecycleBinGeneric::DeleteFile(), DeleteFileToRecycleBinW(), RecycleBinGeneric::EmptyRecycleBin(), EmptyRecycleBinW(), EnumerateRecycleBinW(), GetRecycleBinPathFromDriveNumber(), RecycleBinGenericEnum::Next(), and SHQueryRecycleBinW().

GetRecycleBinFileHandle()

EXTERN_C HDELFILE GetRecycleBinFileHandle	(	IN LPCWSTR pszRoot	OPTIONAL,
		IN const RECYCLEBINFILEIDENTITY *	pFI
	)

Definition at line 278 of file recyclebin.c.

{
    BBENUMFILECONTEXT context = { pFI, NULL };
    EnumerateRecycleBinW(pszRoot, GetRecycleBinFileHandleCallback, &context);
    return context.hDelFile;
}

Referenced by RemoveFromRecycleBinDatabase().

GetRecycleBinFileHandleCallback()

static BOOL CALLBACK GetRecycleBinFileHandleCallback ( IN PVOID  Context, IN HDELFILE  hDeletedFile  )

static

Definition at line 264 of file recyclebin.c.

{
    BBENUMFILECONTEXT *pCtx = (BBENUMFILECONTEXT*)Context;
    IRecycleBinFile *pRBF = IRecycleBinFileFromHDELFILE(hDeletedFile);
    if (IRecycleBinFile_IsEqualIdentity(pRBF, pCtx->pFI) == S_OK)
    {
        pCtx->hDelFile = hDeletedFile;
        return FALSE;
    }
    CloseRecycleBinHandle(hDeletedFile);
    return TRUE;
}

Referenced by GetRecycleBinFileHandle().

GetRecycleBinPathFromDriveNumber()

EXTERN_C HRESULT GetRecycleBinPathFromDriveNumber	(	UINT	Drive,
		LPWSTR	Path
	)

Definition at line 354 of file recyclebin.c.

{
    const WCHAR volume[] = { LOWORD('A' + Drive), ':', '\\', '\0' };
    IRecycleBin *pRB;
    HRESULT hr = GetDefaultRecycleBin(volume, &pRB);
    if (SUCCEEDED(hr))
    {
        hr = IRecycleBin_GetDirectory(pRB, Path);
        IRecycleBin_Release(pRB);
    }
    return hr;
}

Referenced by CRecycleBin::GetFSFolderForItem(), and CRecycleBinFolderViewCB::RegisterChangeNotify().

PathGetDriveNumberW()

EXTERN_C int WINAPI PathGetDriveNumberW

(

_In_

LPCWSTR

)

Referenced by GetDefaultRecycleBin().

RemoveFromRecycleBinDatabase()

EXTERN_C BOOL RemoveFromRecycleBinDatabase

(

IN const RECYCLEBINFILEIDENTITY *

pFI

)

Definition at line 288 of file recyclebin.c.

{
    BOOL ret = FALSE;
    HDELFILE hDelFile = GetRecycleBinFileHandle(NULL, pFI);
    if (hDelFile)
    {
        IRecycleBinFile *rbf = IRecycleBinFileFromHDELFILE(hDelFile);
        ret = SUCCEEDED(IRecycleBinFile_RemoveFromDatabase(rbf));
        CloseRecycleBinHandle(hDelFile);
    }
    return ret;
}

Referenced by FileOpCallback().

RestoreFileFromRecycleBin()

BOOL WINAPI RestoreFileFromRecycleBin

(

IN HDELFILE

hDeletedFile

)

Definition at line 303 of file recyclebin.c.

{
    IRecycleBinFile *rbf = IRecycleBinFileFromHDELFILE(hDeletedFile);
    HRESULT hr;
 
    TRACE("(%p)\n", hDeletedFile);
 
    hr = IRecycleBinFile_Restore(rbf);
    if (SUCCEEDED(hr))
        return TRUE;
    if (HRESULT_FACILITY(hr) == FACILITY_WIN32)
        SetLastError(HRESULT_CODE(hr));
    else
        SetLastError(ERROR_GEN_FAILURE);
    return FALSE;
}