ATSUserList Class Reference

ATS User List. More...

#include <IATSProvider.h>

Inheritance diagram for ATSUserList:

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

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

ATS User List.

Maintains a list of ATSUserEntry objects

See also

ATSUserEntry

Constructor & Destructor Documentation

ATSUserList()

ATSExport ATSUserList

(

)

Constructor.

~ATSUserList()

virtual ATSExport ~ATSUserList ( )

virtual

Destructor.

Member Function Documentation

CreateEntry() [1/2]

virtual ATSExport ATSUserEntry * CreateEntry ( const MCHAR *  szUserName )

virtual

Create and add new ATSUserEntry.

Parameters

[in]

szUserName

string containing user name

Returns

pointer to ATSUserEntry object or NULL if failure

CreateEntry() [2/2]

virtual ATSExport ATSUserEntry * CreateEntry ( ATSUserEntry &  atsUserEntry )

virtual

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

RemoveEntry() [1/2]

virtual ATSExport bool RemoveEntry ( ATSUserEntry *  pEntry )

virtual

Remove entry.

Parameters

[in]

pEntry

Pointer to ATSUserEntry object.

Returns

true if success, false if failure

NumEntries()

virtual ATSExport UINT NumEntries ( )

virtual

Number of entries.

Returns

number of entries in file list

RemoveEntry() [2/2]

virtual ATSExport bool RemoveEntry ( UINT  iIndex )

virtual

Remove entry by index.

Parameters

[in]

iIndex

0-based index into user entry list

Returns

true if success, false if failure

RemoveAll()

virtual ATSExport bool RemoveAll ( )

virtual

Remove all entries.

Returns

true if success, false if failure

GetUserEntry()

virtual ATSExport ATSUserEntry * GetUserEntry ( UINT  iIndex )

virtual

Get entry.

Parameters

[in]

iIndex

0-based index into user entry list

Returns

pointer to ATSUserEntry object or NULL if failure

Member Data Documentation

mATSUsers

std::vector<ATSUserEntry*> mATSUsers

protected