owl::TPidl Class Reference

#include <shellitm.h>

List of all members.

Public Member Functions
	TPidl (LPITEMIDLIST pidl=0)
	TPidl (const TPidl &source)
virtual	~TPidl ()
TPidl &	operator= (const TPidl &source)
TPidl &	operator= (LPITEMIDLIST pidl)
bool	operator! () const
	operator LPCITEMIDLIST () const
	operator LPITEMIDLIST ()
	operator LPCITEMIDLIST * () const
	operator LPITEMIDLIST * ()
ulong	GetSize () const
long	GetItemCount () const
TPidl	GetLastItem () const
TPidl	StripLastItem () const
LPITEMIDLIST	CopyPidl () const
Static Public Member Functions
static LPITEMIDLIST	Next (LPITEMIDLIST pidl)
Protected Member Functions
void	FreePidl ()

---

Detailed Description

TPidl is an item identifier list class (ITEMIDLIST). Its constructor takes an LPITEMIDLIST (a.k.a., pidl). The copy constructor and assignement operators supplied function to manipulate the ITEMIDLIST, get the size, get the number of items in the list, etc, supplied. Normally, the programmer will not have to be concerned with ITEMIDLISTs nor with the TPidl class. The TShellItem class hides all this.

---

Constructor & Destructor Documentation

owl::TPidl::TPidl

(

LPITEMIDLIST

pidl = 0

)

[inline]

Construct a TPidl from an LPITEMIDLIST (pidl)

owl::TPidl::TPidl

(

const TPidl &

source

)

[inline]

TPidl copy constructor.

owl::TPidl::~TPidl

(

)

[inline, virtual]

TPidl destructor.

References FreePidl().

---

Member Function Documentation

LPITEMIDLIST owl::TPidl::CopyPidl

(

)

const

Copy a pidl.

CopyPidl copies a pidl (allocates memory with the shell's allocator)

void owl::TPidl::FreePidl

(

)

[protected]

Free a pidl with the shell's allocator.

protected function used internally to free PIDL memory with the shell's allocator

long owl::TPidl::GetItemCount

(

)

const

Get number of item ids in the TPidl (the TPidl can be a list of ids)

GetItemCount returns the number of identifiers in the identifier list (pidl)

TPidl owl::TPidl::GetLastItem

(

)

const

Get the last item id in the TPidl.

GetLastItem returns the last item in an identifier list for file system items, this is the rightmost part of a path e.g., GetLastItem() on a pidl representing

       "c:\\dir1\\dir2\\dir3\\file1" 

returns "file1"

ulong owl::TPidl::GetSize

(

)

const

Get size (in bytes) of a pidl.

GetSize returns the size (in bytes) of the PIDL.

LPITEMIDLIST owl::TPidl::Next

(

LPITEMIDLIST

pidl

)

[inline, static]

Return next item id (in the list)

owl::TPidl::operator LPCITEMIDLIST

(

)

const [inline]

Use TPidl in place of pidl.

owl::TPidl::operator LPCITEMIDLIST *

(

)

const [inline]

Use TPidl in place of pointer to a pidl.

bool owl::TPidl::operator!

(

)

const [inline]

Check to see if TPidl represents an ITEMIDLIST (return true if it does not)

TPidl & owl::TPidl::operator=

(

const TPidl &

source

)

[inline]

TPidl assignement operator (from another TPidl)

References CopyPidl().

TPidl & owl::TPidl::operator=

(

LPITEMIDLIST

pidl

)

[inline]

TPidl assignement operator (from an LPITEMIDLIST (pidl))

References FreePidl().

TPidl owl::TPidl::StripLastItem

(

)

const

Return a TPidl with the last item id stripped off of it.

StripLastItem returns a pidl stipped of its last (rightmost) item.

---

The documentation for this class was generated from the following files:

• D:/Work/OWLNext/Subversion/branches/632/include/owl/shellitm.h
• D:/Work/OWLNext/Subversion/branches/632/source/owlcore/shellitm.cpp