ATSNotification Class Reference

Search for all occurrences

---

Detailed Description

Register for and Broadcast ATS Notification Messages.

#include <IATSNotifications.h>

Inheritance diagram for ATSNotification:

List of all members.

Static Public Member Functions
static ATSExport bool	RegisterATSNotification (IATSNotifyCallback *pCallback, ATSNotifyClientPtr pClientPtr)
	Register for ATS Notification Messages.
static ATSExport bool	UnRegisterATSNotification (IATSNotifyCallback *pCallback)
	UnRegister for ATS Notification Messages.
static ATSExport ATSNotifyResult	BroadcastATSNotification (ATSNotifyParams *pATSNotifyParamsn)
	Broadcast ATS Notification Message.
static ATSExport ATSNotifyResult	BroadcastATSNotification (ATSNotifyID id, UINT uProviderIndex)
	Broadcast ATS Notification Message.

---

Member Function Documentation

static ATSExport bool RegisterATSNotification	(	IATSNotifyCallback *	pCallback,
		ATSNotifyClientPtr	pClientPtr
	)		[static]

Search for all occurrences

Register for ATS Notification Messages.

See also:

IATSNotifyCallback

Parameters:

[in]	pCallback	pointer to IATSNotifyCallback interface
[in]	pClientPtr	client supplied pointer that will be returned with all notifications

Returns:

true if success, false if failure

static ATSExport bool UnRegisterATSNotification

(

IATSNotifyCallback *

pCallback

)

[static]

Search for all occurrences

UnRegister for ATS Notification Messages.

See also:

IATSNotifyCallback

Parameters:

[in]

pCallback

pointer to IATSNotifyCallback interface

Returns:

true if success, false if failure

static ATSExport ATSNotifyResult BroadcastATSNotification

(

ATSNotifyParams *

pATSNotifyParamsn

)

[static]

Search for all occurrences

Broadcast ATS Notification Message.

See also:

ATSNotifyParams

Parameters:

[in]

pATSNotifyParamsn

pointer to ATSNotifyParams object

Returns:

three values: kATSNotifyResultOk, kATSNotifyResultCancel, or kkATSNotifyResultStop.

static ATSExport ATSNotifyResult BroadcastATSNotification	(	ATSNotifyID	id,
		UINT	uProviderIndex
	)		[static]

Search for all occurrences

Broadcast ATS Notification Message.

Parameters:

[in]	id	ID of notification message. An ATSNotifyParams object will be created with the specified ID and Provder Index.
[in]	uProviderIndex	Index of provider. An ATSNotifyParams object will be created with the specified ID and Provder Index.

Returns:

three values: kATSNotifyResultOk, kATSNotifyResultCancel, or kkATSNotifyResultStop.