IDirList Class Reference

#include <IDirlist.h>

Inheritance diagram for IDirList:

Public Types
enum	{ kDefaultIID = IID_IDIRLIST }

Public Member Functions
virtual uint32	GetCount ()=0
virtual int32	AddDir (const IDFile &dir)=0
virtual bool	GetDir (uint32 index, IDFile &dir)=0
virtual int32	GetDir (uint32 index, NameInfo *ni)=0
virtual void	Empty ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Interface for maintaining a list of links. Whenever a user manually finds a missing link, that link is added to this list. All the directories of these links are looked in to finding missing links. This list is maintained for the duration of the session. A pointer to IDirList can be obtained by querying the session object.

See Also

NameInfo

Member Function Documentation

virtual int32 IDirList::AddDir ( const IDFile &  dir )

pure virtual

Adds the directory referenced by the given data link to the list. This call does not create the temporary file.

Parameters

dir	IN IDFile that references the directory to add.

Returns

0 if the directory was successfully added,\ 1 if invalid parameter, or\ 2 if out of memory.

virtual void IDirList::Empty ( )

pure virtual

Removes all the directories from the list.

virtual uint32 IDirList::GetCount ( )

pure virtual

Returns the number of directories in the list.

Returns

Number of directories in the list.

virtual bool IDirList::GetDir ( uint32  index, IDFile &  dir  )

pure virtual

Gets the directory at the given index from the list.

Parameters

index	IN Index of the directory to get.
dir	OUT Pointer to a existing NameInfo object that is set with the directory information.

Returns

True if the directory was successfully obtained, else false if an invalid index.

virtual int32 IDirList::GetDir ( uint32  index, NameInfo *  ni  )

pure virtual

Gets the directory at the given index from the list.

Parameters

index	IN Index of the directory to get.
ni	OUT Pointer to a existing NameInfo object that is set with the directory information.

Returns

0 if the directory was successfully obtained,\ 2 if invalid parameter.