ATSClientInfo Class Reference

Client information for ATS Providers. More...

#include <IATSProvider.h>

Inheritance diagram for ATSClientInfo:

Public Member Functions
ATSExport	ATSClientInfo ()
	Constructor.
virtual ATSExport	~ATSClientInfo ()
	Destructor.
virtual ATSExport const MCHAR *	GetClientName ()
	Get client name.
virtual ATSExport void	SetClientName (const MCHAR *szClientName)
	Set client name.
virtual ATSExport const MCHAR *	GetUserName ()
	Get user name.
virtual ATSExport void	SetUserName (const MCHAR *szUserName)
	Set user name.
virtual ATSExport HWND	GetParentWindow ()
	Window handle of client.
virtual ATSExport void	SetParentWindow (HWND hHwnd)
	Set window handle of client.
virtual ATSExport const MCHAR *	GetProviderPluginPath ()
	Get Provider plugin path location.
virtual ATSExport void	SetProviderPluginPath (const MCHAR *szPath)
	Set Provider plugin path location.
virtual ATSExport const MCHAR *	GetConfigFilePath ()
	Get Provider configuration file path location.
virtual ATSExport void	SetConfigFilePath (const MCHAR *szPath)
	Set Provider configuration file path location.
virtual ATSExport IATSClientAccess *	GetIATSClientAccess ()
	Get IATSClientAccess interface.
virtual ATSExport void	SetIATSClientAccess (IATSClientAccess *pIATSClientAccess)
	Set IATSClientAccess interface.

Protected Attributes
ATSString	mClientName
ATSString	mUserName
ATSString	mPluginPath
ATSString	mConfigPath
HWND	mHwnd
IATSClientAccess *	mpIATSClientAccess

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

Client information for ATS Providers.

This object provides application specific information to the ATS Provider

Constructor & Destructor Documentation

ATSClientInfo()

ATSExport ATSClientInfo

(

)

Constructor.

~ATSClientInfo()

virtual ATSExport ~ATSClientInfo ( )

virtual

Destructor.

Member Function Documentation

GetClientName()

virtual ATSExport const MCHAR * GetClientName ( )

virtual

Get client name.

The client name is typically the name of the application utilizing the ATS Provider.

Returns

string containing the name of the client.

SetClientName()

virtual ATSExport void SetClientName ( const MCHAR *  szClientName )

virtual

Set client name.

The client name is typically the name of the application utilizing the ATS Provider.

Parameters

[in]

szClientName

string containing the name of the client.

GetUserName()

virtual ATSExport const MCHAR * GetUserName ( )

virtual

Get user name.

This is optional and might be a blank or NULL string.

Returns

string containing the name of the user.

SetUserName()

virtual ATSExport void SetUserName ( const MCHAR *  szUserName )

virtual

Set user name.

Parameters

[in]

szUserName

string containing the name of the user.

GetParentWindow()

virtual ATSExport HWND GetParentWindow ( )

virtual

Window handle of client.

Returns

HWND handle of parent window

SetParentWindow()

virtual ATSExport void SetParentWindow ( HWND  hHwnd )

virtual

Set window handle of client.

Parameters

[in]

hHwnd

HWND handle of parent window

GetProviderPluginPath()

virtual ATSExport const MCHAR * GetProviderPluginPath ( )

virtual

Get Provider plugin path location.

This is used to specify a location in which additional plugins would reside.

Returns

string containing the path

SetProviderPluginPath()

virtual ATSExport void SetProviderPluginPath ( const MCHAR *  szPath )

virtual

Set Provider plugin path location.

This is used to specify a location in which additional plugins would reside.

Parameters

[in]

szPath

string containing the path

GetConfigFilePath()

virtual ATSExport const MCHAR * GetConfigFilePath ( )

virtual

Get Provider configuration file path location.

This is used to specify a location in which additional configuration files would reside.

Returns

string containing the path

SetConfigFilePath()

virtual ATSExport void SetConfigFilePath ( const MCHAR *  szPath )

virtual

Set Provider configuration file path location.

This is used to specify a location in which additional configuration files would reside.

Parameters

[in]

szPath

string containing the path

GetIATSClientAccess()

virtual ATSExport IATSClientAccess * GetIATSClientAccess ( )

virtual

Get IATSClientAccess interface.

See also

IATSClientAccess

Returns

pointer to IATSClientAccess interface

SetIATSClientAccess()

virtual ATSExport void SetIATSClientAccess ( IATSClientAccess *  pIATSClientAccess )

virtual

Set IATSClientAccess interface.

See also

IATSClientAccess

Parameters

[in]

pIATSClientAccess

pointer to IATSClientAccess interface

Member Data Documentation

mClientName

ATSString mClientName

protected

mUserName

ATSString mUserName

protected

mPluginPath

ATSString mPluginPath

protected

mConfigPath

ATSString mConfigPath

protected

mHwnd

HWND mHwnd

protected

mpIATSClientAccess

IATSClientAccess* mpIATSClientAccess

protected