util.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
template<class H >
static int	ErrorBox (H hWnd, int Error)
template<class T >
static bool	IsPathSep (T c)
bool	IsEqual (const SHCOLUMNID &scid, REFGUID guid, UINT pid)
HRESULT	InitVariantFromBuffer (const void *buffer, UINT cb, VARIANT *pv)
void	FreeStrRet (STRRET &str)
HRESULT	StrTo (LPCWSTR str, UINT len, STRRET &sr)
HRESULT	StrTo (LPCWSTR str, STRRET &sr)
HRESULT	StrTo (LPCWSTR str, UINT len, VARIANT &v)
HRESULT	StrTo (LPCWSTR str, VARIANT &v)
HRESULT	StrRetToVariantBSTR (STRRET *psr, VARIANT &v)
HRESULT	GetDetailsOf (IShellFolder2 &Folder, PCUITEMID_CHILD pidl, UINT Column, PWSTR &String)
HRESULT	InsertMenuItem (QCMINFO &qcmi, UINT &Pos, UINT &TrackId, UINT Id, UINT ResId, int State=0)
SFGAOF	MapFSToSFAttributes (UINT att)
bool	IncludeInEnumIDList (SHCONTF contf, SFGAOF att)
int	MapPIDLToSystemImageListIndex (IShellFolder *pSF, PCUITEMID_CHILD pidl, UINT GilFlags=0)

Function Documentation

ErrorBox()

template<class H >

static int ErrorBox ( H  hWnd, int  Error  )

static

Definition at line 10 of file util.h.

{
    SHELL_ErrorBox(hWnd, Error);
    return Error;
}

FreeStrRet()

void FreeStrRet ( STRRET &  str )

inline

Definition at line 40 of file util.h.

{
    if (str.uType == STRRET_WSTR)
    {
        SHFree(str.pOleStr);
        str.uType = STRRET_CSTR;
    }
}

GetDetailsOf()

HRESULT GetDetailsOf ( IShellFolder2 &  Folder, PCUITEMID_CHILD  pidl, UINT  Column, PWSTR &  String  )

inline

Definition at line 88 of file util.h.

{
    SHELLDETAILS details;
    HRESULT hr = Folder.GetDetailsOf(pidl, Column, &details);
    if (SUCCEEDED(hr))
        hr = StrRetToStrW(&details.str, pidl, &String);
    return hr;
}

Referenced by DECLARE_INTERFACE_().

IncludeInEnumIDList()

bool IncludeInEnumIDList ( SHCONTF  contf, SFGAOF  att  )

inline

Definition at line 131 of file util.h.

{
    const SHCONTF both = SHCONTF_FOLDERS | SHCONTF_NONFOLDERS;
    const SFGAOF superbits = SFGAO_HIDDEN | SFGAO_READONLY | SFGAO_SYSTEM;
    const bool isfile = (att & (SFGAO_STREAM | SFGAO_FOLDER)) != SFGAO_FOLDER;
    if ((contf & both) != both && !(contf & SHCONTF_STORAGE))
    {
        if (isfile && (contf & SHCONTF_FOLDERS))
            return false;
        if ((att & SFGAO_FOLDER) && (contf & SHCONTF_NONFOLDERS))
            return false;
    }
    if ((att & SFGAO_HIDDEN) && !(contf & (SHCONTF_INCLUDEHIDDEN | SHCONTF_STORAGE)))
        return false;
    if ((att & superbits) > SFGAO_HIDDEN && !(contf & (SHCONTF_INCLUDESUPERHIDDEN | SHCONTF_STORAGE)))
        return false;
    return true;
}

Referenced by EnumFillCallback().

InitVariantFromBuffer()

HRESULT InitVariantFromBuffer ( const void *  buffer, UINT  cb, VARIANT *  pv  )

inline

Definition at line 26 of file util.h.

{
    SAFEARRAY *pa = SafeArrayCreateVector(VT_UI1, 0, cb);
    if (pa)
    {
        CopyMemory(pa->pvData, buffer, cb);
        V_VT(pv) = VT_UI1 | VT_ARRAY;
        V_UNION(pv, parray) = pa;
        return S_OK;
    }
    V_VT(pv) = VT_EMPTY;
    return E_OUTOFMEMORY;
}

Referenced by CCabFolder::GetDetailsEx(), and test_InitPropVariantFromBuffer().

InsertMenuItem()

HRESULT InsertMenuItem ( QCMINFO &  qcmi, UINT &  Pos, UINT &  TrackId, UINT  Id, UINT  ResId, int  State = 0  )

inline

Definition at line 97 of file util.h.

{
    UINT flags = 0;
    WCHAR string[MAX_PATH];
    string[0] = UNICODE_NULL;
    if ((Id += qcmi.idCmdFirst) > qcmi.idCmdLast)
        return E_FAIL;
    else if (ResId == (UINT)-1)
        flags |= MF_SEPARATOR;
    else if (!LoadStringW(_AtlBaseModule.GetResourceInstance(), ResId, string, _countof(string)))
        return E_FAIL;
 
    MENUITEMINFOW mii;
    mii.cbSize = FIELD_OFFSET(MENUITEMINFOW, hbmpItem); // USER32 version agnostic
    mii.fMask = MIIM_FTYPE | MIIM_ID | MIIM_STRING | MIIM_STATE;
    mii.fType = flags;
    mii.wID = Id;
    mii.dwTypeData = string;
    mii.cch = 0;
    mii.fState = State;
    if (!InsertMenuItemW(qcmi.hmenu, Pos, TRUE, &mii))
        return E_FAIL;
    Pos++;
    TrackId = max(TrackId, Id);
    return S_OK;
}

IsEqual()

bool IsEqual ( const SHCOLUMNID &  scid, REFGUID  guid, UINT  pid  )

inline

Definition at line 21 of file util.h.

{
    return scid.pid == pid && IsEqualGUID(scid.fmtid, guid);
}

IsPathSep()

template<class T >

static bool IsPathSep ( T  c )

inlinestatic

Definition at line 16 of file util.h.

{
    return c == '\\' || c == '/';
}

Referenced by BuildPath().

MapFSToSFAttributes()

SFGAOF MapFSToSFAttributes ( UINT  att )

inline

Definition at line 124 of file util.h.

{
    return ((att & FILE_ATTRIBUTE_READONLY) ? SFGAO_READONLY : 0) |
           ((att & FILE_ATTRIBUTE_HIDDEN) ? SFGAO_HIDDEN : 0) |
           ((att & FILE_ATTRIBUTE_SYSTEM) ? SFGAO_SYSTEM : 0);
}

Referenced by EnumFillCallback(), and CCabFolder::GetAttributesOf().

MapPIDLToSystemImageListIndex()

int MapPIDLToSystemImageListIndex ( IShellFolder *  pSF, PCUITEMID_CHILD  pidl, UINT  GilFlags = 0  )

inline

Definition at line 150 of file util.h.

{
    int normal, open;
    BOOL qopen = GilFlags & GIL_OPENICON;
    normal = SHMapPIDLToSystemImageListIndex(pSF, pidl, qopen ? &open : NULL);
    return qopen && open != -1 ? open : normal;
}

Referenced by CCabFolder::GetIconOf().

StrRetToVariantBSTR()

HRESULT StrRetToVariantBSTR ( STRRET *  psr, VARIANT &  v  )

inline

Definition at line 80 of file util.h.

{
    HRESULT hr = StrRetToBSTR(psr, NULL, &V_BSTR(&v));
    if (SUCCEEDED(hr))
        V_VT(&v) = VT_BSTR;
    return hr;
}

Referenced by CCabFolder::GetItemDetails().

StrTo() [1/4]

HRESULT StrTo ( LPCWSTR  str, STRRET &  sr  )

inline

Definition at line 60 of file util.h.

{
    return StrTo(str, lstrlenW(str), sr);
}

StrTo() [2/4]

HRESULT StrTo ( LPCWSTR  str, UINT  len, STRRET &  sr  )

inline

Definition at line 49 of file util.h.

{
    LPWSTR data = (LPWSTR)SHAlloc(++len * sizeof(WCHAR));
    if (!data)
        return E_OUTOFMEMORY;
    lstrcpynW(data, str, len);
    sr.uType = STRRET_WSTR;
    sr.pOleStr = data;
    return S_OK;
}

Referenced by CCabFolder::GetDetailsOf(), CCabFolder::GetDisplayNameOf(), CCabFolder::GetItemDetails(), and StrTo().

StrTo() [3/4]

HRESULT StrTo ( LPCWSTR  str, UINT  len, VARIANT &  v  )

inline

Definition at line 65 of file util.h.

{
    BSTR data = SysAllocStringLen(str, len);
    if (!data)
        return E_OUTOFMEMORY;
    V_VT(&v) = VT_BSTR;
    V_BSTR(&v) = data;
    return S_OK;
}

StrTo() [4/4]

HRESULT StrTo ( LPCWSTR  str, VARIANT &  v  )

inline

Definition at line 75 of file util.h.

{
    return StrTo(str, lstrlenW(str), v);
}