3ds Max C++ API Reference
ATSUserEntry Class Reference

ATS User Object. More...

#include <IATSProvider.h>

+ Inheritance diagram for ATSUserEntry:

Public Member Functions

ATSExport ATSUserEntry ()
 Constructor. More...
 
virtual ATSExport ~ATSUserEntry ()
 Destructor. More...
 
virtual ATSExport const MCHARGetUserName ()
 Get user name. More...
 
virtual ATSExport void SetUserName (const MCHAR *szUserName)
 Set user name. More...
 
virtual ATSExport const MCHARGetFirstName ()
 Get user's first name. More...
 
virtual ATSExport void SetFirstName (const MCHAR *szFirstName)
 Set user's first name. More...
 
virtual ATSExport const MCHARGetLastName ()
 Get user's last name. More...
 
virtual ATSExport void SetLastName (const MCHAR *szLastName)
 Set user's last name. More...
 
virtual ATSExport const MCHARGetEmail ()
 Get user's email. More...
 
virtual ATSExport void SetEmail (const MCHAR *szEmail)
 Set user's email. More...
 

Protected Attributes

ATSString mUserName
 
ATSString mFirstName
 
ATSString mLastName
 
ATSString mEmail
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 

Detailed Description

ATS User Object.

ATSUserEntry describes public data about a provider's user

See also
ATSUserList

Constructor & Destructor Documentation

◆ ATSUserEntry()

Constructor.

◆ ~ATSUserEntry()

virtual ATSExport ~ATSUserEntry ( )
virtual

Destructor.

Member Function Documentation

◆ GetUserName()

virtual ATSExport const MCHAR* GetUserName ( )
virtual

Get user name.

Returns
string containing the user's name

◆ SetUserName()

virtual ATSExport void SetUserName ( const MCHAR szUserName)
virtual

Set user name.

Parameters
szUserNamestring containing the user's name

◆ GetFirstName()

virtual ATSExport const MCHAR* GetFirstName ( )
virtual

Get user's first name.

Returns
string containing the user's first name

◆ SetFirstName()

virtual ATSExport void SetFirstName ( const MCHAR szFirstName)
virtual

Set user's first name.

Parameters
szFirstNamestring containing the user's first name

◆ GetLastName()

virtual ATSExport const MCHAR* GetLastName ( )
virtual

Get user's last name.

Returns
string containing the user's last name

◆ SetLastName()

virtual ATSExport void SetLastName ( const MCHAR szLastName)
virtual

Set user's last name.

Parameters
szLastNamestring containing the user's last name

◆ GetEmail()

virtual ATSExport const MCHAR* GetEmail ( )
virtual

Get user's email.

Returns
string containing the user's email

◆ SetEmail()

virtual ATSExport void SetEmail ( const MCHAR szEmail)
virtual

Set user's email.

Parameters
szEmailstring containing the user's email

Member Data Documentation

◆ mUserName

ATSString mUserName
protected

◆ mFirstName

ATSString mFirstName
protected

◆ mLastName

ATSString mLastName
protected

◆ mEmail

ATSString mEmail
protected