#include <IATSProvider.h>
Class Description
ATS User List.
Maintains a list of ATSUserEntry objects
- See also:
- ATSUserEntry
Constructor & Destructor Documentation
Member Function Documentation
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
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] |
Remove entry.
- Parameters:
-
- Returns:
- true if success, false if failure
virtual ATSExport UINT NumEntries |
( |
|
) |
[virtual] |
Number of entries.
- Returns:
- number of entries in file list
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
virtual ATSExport bool RemoveAll |
( |
|
) |
[virtual] |
Remove all entries.
- Returns:
- true if success, false if failure
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