shellutils.h File Reference

Go to the source code of this file.

Macros
#define	DbgPrint(fmt, ...)    Win32DbgPrint(__FILE__, __LINE__, fmt, ##__VA_ARGS__)
#define	IID_PPV_ARG(Itype, ppType)   &IID_##Itype, (void**)(ppType)
#define	IID_NULL_PPV_ARG(Itype, ppType)   &IID_##Itype, NULL, (void**)(ppType)
#define	FAILED_UNEXPECTEDLY(hr)   _ROS_FAILED_HELPER((hr), #hr, __FILE__, __LINE__)
#define	SHELL_ErrorBox   SHELL_ErrorBoxHelper
#define	S_LESSTHAN   0xffff
#define	S_EQUAL   S_OK
#define	S_GREATERTHAN   S_FALSE
#define	MAKE_COMPARE_HRESULT(x)   ((x)>0 ? S_GREATERTHAN : ((x)<0 ? S_LESSTHAN : S_EQUAL))
#define	SHELL_GetSetting(pss, ssf, field)   ( SHGetSetSettings((pss), (ssf), FALSE), (pss)->field )

Functions
static ULONG	Win32DbgPrint (const char *filename, int line, const char *lpFormat,...)
static HRESULT	HResultFromWin32 (DWORD hr)
static BOOL	_ROS_FAILED_HELPER (HRESULT hr, const char *expr, const char *filename, int line)
static UINT	SHELL_ErrorBoxHelper (HWND hwndOwner, UINT Error)
static HRESULT	SHELL_RegGetStringEx (HKEY hKey, PCWSTR pszPath, PCWSTR pszName, UINT SRRF, PWSTR pszOut, DWORD cchMax)
static HRESULT	SHELL_RegGetString (HKEY hKey, PCWSTR pszPath, PCWSTR pszName, PWSTR pszOut, DWORD cchMax)
static BOOL	SHELL_IsContextMenuMsg (UINT uMsg)
static BOOL	ILIsSingle (LPCITEMIDLIST pidl)
static PCUIDLIST_ABSOLUTE	HIDA_GetPIDLFolder (CIDA const *pida)
static PCUIDLIST_RELATIVE	HIDA_GetPIDLItem (CIDA const *pida, SIZE_T i)
static SFGAOF	SHELL_GetAttributesOf (IShellFolder *psf, LPCITEMIDLIST pidlChild, SFGAOF query)
static SFGAOF	SHELL_GetAttributesOfAbsolute (PCIDLIST_ABSOLUTE pidl, SFGAOF query)
static void	DumpIdListOneLine (LPCITEMIDLIST pidl)

Macro Definition Documentation

DbgPrint

#define DbgPrint	(		fmt,
			...
	)		Win32DbgPrint(__FILE__, __LINE__, fmt, ##__VA_ARGS__)

Definition at line 59 of file shellutils.h.

FAILED_UNEXPECTEDLY

#define FAILED_UNEXPECTEDLY

(

hr

)

_ROS_FAILED_HELPER((hr), #hr, __FILE__, __LINE__)

Definition at line 88 of file shellutils.h.

IID_NULL_PPV_ARG

#define IID_NULL_PPV_ARG	(		Itype,
			ppType
	)		&IID_##Itype, NULL, (void**)(ppType)

Definition at line 67 of file shellutils.h.

IID_PPV_ARG

#define IID_PPV_ARG	(		Itype,
			ppType
	)		&IID_##Itype, (void**)(ppType)

Definition at line 66 of file shellutils.h.

MAKE_COMPARE_HRESULT

#define MAKE_COMPARE_HRESULT

(

x

)

((x)>0 ? S_GREATERTHAN : ((x)<0 ? S_LESSTHAN : S_EQUAL))

Definition at line 740 of file shellutils.h.

S_EQUAL

#define S_EQUAL   S_OK

Definition at line 738 of file shellutils.h.

S_GREATERTHAN

#define S_GREATERTHAN   S_FALSE

Definition at line 739 of file shellutils.h.

S_LESSTHAN

#define S_LESSTHAN   0xffff

Definition at line 737 of file shellutils.h.

SHELL_ErrorBox

#define SHELL_ErrorBox   SHELL_ErrorBoxHelper

Definition at line 126 of file shellutils.h.

SHELL_GetSetting

#define SHELL_GetSetting	(		pss,
			ssf,
			field
	)		( SHGetSetSettings((pss), (ssf), FALSE), (pss)->field )

Definition at line 1021 of file shellutils.h.

Function Documentation

_ROS_FAILED_HELPER()

static BOOL _ROS_FAILED_HELPER ( HRESULT  hr, const char *  expr, const char *  filename, int  line  )

inlinestatic

Definition at line 78 of file shellutils.h.

{
    if (FAILED(hr))
    {
        Win32DbgPrint(filename, line, "Unexpected failure (%s)=%08x.\n", expr, hr);
        return TRUE;
    }
    return FALSE;
}

DumpIdListOneLine()

static void DumpIdListOneLine ( LPCITEMIDLIST  pidl )

inlinestatic

Definition at line 1024 of file shellutils.h.

{
    char buf[1024], *data, drive = 0;
    for (UINT depth = 0, type; ; pidl = ILGetNext(pidl), ++depth)
    {
        if (!pidl || !pidl->mkid.cb)
        {
            if (!depth)
            {
                wsprintfA(buf, "%p [] (%s)", pidl, pidl ? "Empty/Desktop" : "NULL");
                OutputDebugStringA(buf);
            }
            break;
        }
        else if (!depth)
        {
            wsprintfA(buf, "%p", pidl);
            OutputDebugStringA(buf);
        }
        type = pidl->mkid.abID[0] & 0x7f;
        data = (char*)&pidl->mkid.abID[0];
        if (depth == 0 && type == 0x1f && pidl->mkid.cb == 20 && *(UINT*)(&data[2]) == 0x20D04FE0)
        {
            wsprintfA(buf, " [%.2x ThisPC?]", type); /* "?" because we did not check the full GUID */
        }
        else if (depth == 1 && type >= 0x20 && type < 0x30 && type != 0x2E && pidl->mkid.cb > 4)
        {
            drive = data[1];
            wsprintfA(buf, " [%.2x %c: %ub]", type, drive, pidl->mkid.cb);
        }
        else if (depth >= 2 && drive && (type & 0x70) == 0x30) /* PT_FS */
        {
            if (type & 4)
                wsprintfA(buf, " [%.2x FS %.256ls %ub]", type, data + 12, pidl->mkid.cb);
            else
                wsprintfA(buf, " [%.2x FS %.256hs %ub]", type, data + 12, pidl->mkid.cb);
        }
        else
        {
            wsprintfA(buf, " [%.2x ? %ub]", type, pidl->mkid.cb);
        }
        OutputDebugStringA(buf);
    }
    OutputDebugStringA("\n");
}

HIDA_GetPIDLFolder()

static PCUIDLIST_ABSOLUTE HIDA_GetPIDLFolder ( CIDA const *  pida )

inlinestatic

Definition at line 770 of file shellutils.h.

{
    return (PCUIDLIST_ABSOLUTE)(((LPBYTE)pida) + (pida)->aoffset[0]);
}

Referenced by _ILCopyCidaToaPidl(), DeleteFontFiles(), CMyDocsDropHandler::Drop(), CDeskLinkDropHandler::Drop(), CShellItemArray::GetItemAt(), COpenWithMenu::Initialize(), InstallFontsFromDataObject(), SHELL_CIDA_ILCloneFull(), SHELL_CloneDataObject(), SHGetAttributesFromDataObject(), SHGetItemFromDataObject(), and TestHIDA().

HIDA_GetPIDLItem()

static PCUIDLIST_RELATIVE HIDA_GetPIDLItem ( CIDA const *  pida, SIZE_T  i  )

inlinestatic

Definition at line 775 of file shellutils.h.

{
    return (PCUIDLIST_RELATIVE)(((LPBYTE)pida) + (pida)->aoffset[i + 1]);
}

Referenced by _ILCopyCidaToaPidl(), DeleteFontFiles(), CZipFolder::DeleteItems(), DoPreviewFontFiles(), CMyDocsDropHandler::Drop(), CDeskLinkDropHandler::Drop(), ExtractFilesCallback(), FSFolderItemPropDialogInitCallback(), CShellItemArray::GetItemAt(), COpenWithMenu::Initialize(), InstallFontsFromDataObject(), SHELL32_ShowFilesystemItemPropertiesDialogAsync(), SHELL_CIDA_ILCloneFull(), SHGetAttributesFromDataObject(), SHGetItemFromDataObject(), and TestHIDA().

HResultFromWin32()

static HRESULT HResultFromWin32 ( DWORD  hr )

inlinestatic

Definition at line 70 of file shellutils.h.

{
     // HRESULT_FROM_WIN32 will evaluate its parameter twice, this function will not.
    return HRESULT_FROM_WIN32(hr);
}

ILIsSingle()

static BOOL ILIsSingle ( LPCITEMIDLIST  pidl )

inlinestatic

Definition at line 765 of file shellutils.h.

{
    return pidl == ILFindLastID(pidl);
}

Referenced by CCabFolder::CompareIDs(), CNetworkConnections::CompareIDs(), and SHOpenFolderAndSelectItems().

SHELL_ErrorBoxHelper()

static UINT SHELL_ErrorBoxHelper ( HWND  hwndOwner, UINT  Error  )

inlinestatic

Definition at line 98 of file shellutils.h.

{
    WCHAR buf[400];
    UINT cch;
 
    if (!IsWindowVisible(hwndOwner))
        hwndOwner = NULL;
    if (Error == ERROR_SUCCESS)
        Error = ERROR_INTERNAL_ERROR;
 
    cch = FormatMessageW(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
                         NULL, Error, 0, buf, _countof(buf), NULL);
    if (!cch)
    {
        enum { user32_IDS_ERROR = 2 }; // IDS_ERROR from user32 resource.h ("Error" string)
        cch = LoadStringW(LoadLibraryW(L"USER32"), user32_IDS_ERROR, buf, _countof(buf));
        wsprintfW(buf + cch, L"\n\n%#x (%d)", Error, Error);
    }
    MessageBoxW(hwndOwner, buf, NULL, MB_OK | MB_ICONSTOP);
    return Error;
}

SHELL_GetAttributesOf()

static SFGAOF SHELL_GetAttributesOf ( IShellFolder *  psf, LPCITEMIDLIST  pidlChild, SFGAOF  query  )

inlinestatic

Definition at line 780 of file shellutils.h.

{
    SFGAOF attr = query;
#ifdef __cplusplus
    HRESULT hr = psf ? psf->GetAttributesOf(1, &pidlChild, &attr) : E_INVALIDARG;
#else
    HRESULT hr = psf ? psf->lpVtbl->GetAttributesOf(psf, 1, &pidlChild, &attr) : E_INVALIDARG;
#endif
    return SUCCEEDED(hr) ? (attr & query) : 0;
}

Referenced by GetFolderItemBaseType(), SHELL_BrowseObject(), SHELL_GetAbsolutePidlTryLinkTarget(), and SHELL_GetAttributesOfAbsolute().

SHELL_GetAttributesOfAbsolute()

static SFGAOF SHELL_GetAttributesOfAbsolute ( PCIDLIST_ABSOLUTE  pidl, SFGAOF  query  )

inlinestatic

Definition at line 791 of file shellutils.h.

{
    IShellFolder *psf;
    PCUITEMID_CHILD pidlChild;
    HRESULT hr = SHBindToParent(pidl, IID_PPV_ARG(IShellFolder, &psf), &pidlChild);
    if (SUCCEEDED(hr))
    {
        SFGAOF attrib = SHELL_GetAttributesOf(psf, pidlChild, query);
#ifdef __cplusplus
        psf->Release();
#else
        psf->lpVtbl->Release(psf);
#endif
        return attrib;
    }
    return 0;
}

SHELL_IsContextMenuMsg()

static BOOL SHELL_IsContextMenuMsg ( UINT  uMsg )

inlinestatic

Definition at line 759 of file shellutils.h.

{
    return uMsg == WM_MEASUREITEM || uMsg == WM_DRAWITEM ||
           uMsg == WM_INITMENUPOPUP || uMsg == WM_MENUSELECT || uMsg == WM_MENUCHAR;
}

Referenced by BrFolderDlgProc(), and CDefaultContextMenu::HandleMenuMsg2().

SHELL_RegGetString()

static HRESULT SHELL_RegGetString ( HKEY  hKey, PCWSTR  pszPath, PCWSTR  pszName, PWSTR  pszOut, DWORD  cchMax  )

inlinestatic

Definition at line 141 of file shellutils.h.

{
    return SHELL_RegGetStringEx(hKey, pszPath, pszName, 1 << REG_SZ, pszOut, cchMax);
}

Referenced by GetClassKeyName(), and OpenClassKey().

SHELL_RegGetStringEx()

static HRESULT SHELL_RegGetStringEx ( HKEY  hKey, PCWSTR  pszPath, PCWSTR  pszName, UINT  SRRF, PWSTR  pszOut, DWORD  cchMax  )

inlinestatic

Definition at line 130 of file shellutils.h.

{
#ifndef SRRF_RT_REG_SZ
    LSTATUS WINAPI SHRegGetValueW(HKEY h, LPCWSTR p, LPCWSTR n, UINT f, LPDWORD t, LPVOID d, LPDWORD s);
#endif
    DWORD cb = cchMax * sizeof(*pszOut);
    UINT err = SHRegGetValueW(hKey, pszPath, pszName, SRRF, NULL, pszOut, &cb);
    return err ? HRESULT_FROM_WIN32(err) : (cb / sizeof(*pszOut));
}

Referenced by SHELL_RegGetString().

Win32DbgPrint()

static ULONG Win32DbgPrint ( const char *  filename, int  line, const char *  lpFormat,   ...  )

inlinestatic

Definition at line 27 of file shellutils.h.

{
    char szMsg[512];
    char *szMsgStart;
    const char *fname;
    va_list vl;
 
    fname = strrchr(filename, '\\');
    if (fname == NULL)
    {
        fname = strrchr(filename, '/');
        if (fname != NULL)
            fname++;
    }
    else
        fname++;
 
    if (fname == NULL)
        fname = filename;
 
    szMsgStart = szMsg + sprintf(szMsg, "%s:%d: ", fname, line);
 
    va_start(vl, lpFormat);
    vsprintf(szMsgStart, lpFormat, vl);
    va_end(vl);
 
    OutputDebugStringA(szMsg);
 
    /* Return STATUS_SUCCESS, since we are supposed to mimic DbgPrint */
    return 0;
}

Referenced by _ROS_FAILED_HELPER().