ATSClientInfo Class Reference

Search for all occurrences

---

Detailed Description

Client information for ATS Providers.

This object provides application specific information to the ATS Provider

#include <IATSProvider.h>

Inheritance diagram for ATSClientInfo:

List of all members.

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

---

Constructor & Destructor Documentation

ATSExport ATSClientInfo

(

)

Constructor.

virtual ATSExport ~ATSClientInfo

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual ATSExport const MCHAR* GetClientName

(

)

[virtual]

Search for all occurrences

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.

virtual ATSExport void SetClientName

(

const MCHAR *

szClientName

)

[virtual]

Search for all occurrences

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.

virtual ATSExport const MCHAR* GetUserName

(

)

[virtual]

Search for all occurrences

Get user name.

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

Returns:

string containing the name of the user.

virtual ATSExport void SetUserName

(

const MCHAR *

szUserName

)

[virtual]

Search for all occurrences

Set user name.

Parameters:

[in]

szUserName

string containing the name of the user.

virtual ATSExport HWND GetParentWindow

(

)

[virtual]

Search for all occurrences

Window handle of client.

Returns:

HWND handle of parent window

virtual ATSExport void SetParentWindow

(

HWND

hHwnd

)

[virtual]

Search for all occurrences

Set window handle of client.

Parameters:

[in]

hHwnd

HWND handle of parent window

virtual ATSExport const MCHAR* GetProviderPluginPath

(

)

[virtual]

Search for all occurrences

Get Provider plugin path location.

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

Returns:

string containing the path

virtual ATSExport void SetProviderPluginPath

(

const MCHAR *

szPath

)

[virtual]

Search for all occurrences

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

virtual ATSExport const MCHAR* GetConfigFilePath

(

)

[virtual]

Search for all occurrences

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

virtual ATSExport void SetConfigFilePath

(

const MCHAR *

szPath

)

[virtual]

Search for all occurrences

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

virtual ATSExport IATSClientAccess* GetIATSClientAccess

(

)

[virtual]

Search for all occurrences

Get IATSClientAccess interface.

See also:

IATSClientAccess

Returns:

pointer to IATSClientAccess interface

virtual ATSExport void SetIATSClientAccess

(

IATSClientAccess *

pIATSClientAccess

)

[virtual]

Search for all occurrences

Set IATSClientAccess interface.

See also:

IATSClientAccess

Parameters:

[in]

pIATSClientAccess

pointer to IATSClientAccess interface

---

Member Data Documentation

ATSString mClientName [protected]

Search for all occurrences

ATSString mUserName [protected]

Search for all occurrences

ATSString mPluginPath [protected]

Search for all occurrences

ATSString mConfigPath [protected]

Search for all occurrences

HWND mHwnd [protected]

Search for all occurrences

IATSClientAccess* mpIATSClientAccess [protected]

Search for all occurrences