ATSUserList Class Reference

Search for all occurrences

---

Detailed Description

ATS User List.

Maintains a list of ATSUserEntry objects

See also:

ATSUserEntry

#include <IATSProvider.h>

Inheritance diagram for ATSUserList:

List of all members.

Public Member Functions
ATSExport	ATSUserList ()
	Constructor.
virtual ATSExport	~ATSUserList ()
	Destructor.
virtual ATSExport ATSUserEntry *	CreateEntry (const MCHAR *szUserName)
	Create and add new ATSUserEntry.
virtual ATSExport ATSUserEntry *	CreateEntry (ATSUserEntry &atsUserEntry)
	Copy and add new ATSUserEntry.
virtual ATSExport bool	RemoveEntry (ATSUserEntry *pEntry)
	Remove entry.
virtual ATSExport UINT	NumEntries ()
	Number of entries.
virtual ATSExport bool	RemoveEntry (UINT iIndex)
	Remove entry by index.
virtual ATSExport bool	RemoveAll ()
	Remove all entries.
virtual ATSExport ATSUserEntry *	GetUserEntry (UINT iIndex)
	Get entry.
Protected Attributes
std::vector< ATSUserEntry * >	mATSUsers

---

Constructor & Destructor Documentation

ATSExport ATSUserList

(

)

Constructor.

virtual ATSExport ~ATSUserList

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual ATSExport ATSUserEntry* CreateEntry

(

const MCHAR *

szUserName

)

[virtual]

Search for all occurrences

Create and add new ATSUserEntry.

Parameters:

[in]

szUserName

string containing user name

Returns:

pointer to ATSUserEntry object or NULL if failure

virtual ATSExport ATSUserEntry* CreateEntry

(

ATSUserEntry &

atsUserEntry

)

[virtual]

Search for all occurrences

Copy and add new ATSUserEntry.

Parameters:

[in]

atsUserEntry

This ATSUserEntry object is copied and added to the entry list.

Returns:

pointer to ATSUserEntry object or NULL if failure

virtual ATSExport bool RemoveEntry

(

ATSUserEntry *

pEntry

)

[virtual]

Search for all occurrences

Remove entry.

Parameters:

[in]

pEntry

Pointer to ATSUserEntry object.

Returns:

true if success, false if failure

virtual ATSExport UINT NumEntries

(

)

[virtual]

Search for all occurrences

Number of entries.

Returns:

number of entries in file list

virtual ATSExport bool RemoveEntry

(

UINT

iIndex

)

[virtual]

Search for all occurrences

Remove entry by index.

Parameters:

[in]

iIndex

0-based index into user entry list

Returns:

true if success, false if failure

virtual ATSExport bool RemoveAll

(

)

[virtual]

Search for all occurrences

Remove all entries.

Returns:

true if success, false if failure

virtual ATSExport ATSUserEntry* GetUserEntry

(

UINT

iIndex

)

[virtual]

Search for all occurrences

Get entry.

Parameters:

[in]

iIndex

0-based index into user entry list

Returns:

pointer to ATSUserEntry object or NULL if failure

---

Member Data Documentation

std::vector<ATSUserEntry*> mATSUsers [protected]

Search for all occurrences