IATSClientAccess Class Reference

Search for all occurrences

---

Detailed Description

Access to client of ATS Provider.

This interface provides runtime access to the client application.

See also:

ATSClientInfo

#include <IATSProvider.h>

Inheritance diagram for IATSClientAccess:

List of all members.

Public Member Functions
virtual bool	SendStatusText (const MCHAR *szText, ATSStatus dwStatus=ATS::kATSStatusTextNone)=0
	Send status message to client.
virtual HWND	GetParentWindow ()=0
	Window handle of client.
virtual DWORD	GetUIColor (int iIndex)=0
	Get UI colors.
virtual bool	SilentMode ()=0
	Get silent mode status.
virtual ATSOption	GetClientOptions ()=0
	Get ATS Client options.

---

Member Function Documentation

virtual bool SendStatusText	(	const MCHAR *	szText,
		ATSStatus	dwStatus = ATS::kATSStatusTextNone
	)		[pure virtual]

Search for all occurrences

Send status message to client.

Parameters:

[in]	szText	string contaning status message
[in]	dwStatus	Currently not used. status of message.

Returns:

true if success, false if failure

virtual HWND GetParentWindow

(

)

[pure virtual]

Search for all occurrences

Window handle of client.

Returns:

HWND handle of parent window

virtual DWORD GetUIColor

(

int

iIndex

)

[pure virtual]

Search for all occurrences

Get UI colors.

Allows an ATS Provider to access custom application color settings.

Parameters:

[in]

iIndex

same index used in Window's GetSysColor method.

Returns:

color value.

virtual bool SilentMode

(

)

[pure virtual]

Search for all occurrences

Get silent mode status.

Returns:

true if in silent mode, false if not.

virtual ATSOption GetClientOptions

(

)

[pure virtual]

Search for all occurrences

Get ATS Client options.

Returns:

ATS option flags