ASUserInteractionSuite Struct Reference
[API Suite List]

This suite provides access to the application preference for how the application responds to messages. More...

#include <ASUserInteraction.h>

List of all members.

Public Attributes
ASAPI ASInteractionAllowed(*	GetInteractionAllowed )(void)
	Reports the level of interaction that is allowed between the application and the user, according to the application preference.
ASAPI ASErr(*	SetInteractionAllowed )(ASInteractionAllowed allowed)
	Sets the level of interaction that is allowed between the application and the user.
ASAPI ASBoolean(*	InteractWithUser )(void)
	Reports whether interaction is allowed between the application and the user in the current application context.
ASAPI ASErr(*	LogInteraction )(const char *msg)
	Sets the log message using a C string.
ASAPI ASErr(*	LogInteractionW )(const ASUnicode *msg)
	Sets the log message using a Unicode string.

---

Detailed Description

This suite provides access to the application preference for how the application responds to messages.

When user interaction is on, the application displays alerts in response to informational, warning, and error messages. When it is off, the application writes to a log file.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kASUserInteractionSuite and kASUserInteractionVersion.

---

Member Data Documentation

ASAPI ASInteractionAllowed(* ASUserInteractionSuite::GetInteractionAllowed)(void)

Reports the level of interaction that is allowed between the application and the user, according to the application preference.

(Note that this function returns a constant value, not an error code.)

Returns:

The interaction level constant.

ASAPI ASBoolean(* ASUserInteractionSuite::InteractWithUser)(void)

Reports whether interaction is allowed between the application and the user in the current application context.

(Note that this function returns a boolean value, not an error code.)

Returns:

True if the interaction level is anything other than kASInteractWithNone.

Referenced by ASUserInteractionChecker::InteractWithUser().

ASAPI ASErr(* ASUserInteractionSuite::LogInteraction)(const char *msg)

Sets the log message using a C string.

This message is written to the log file when an alert condition occurs, if user interactivity is turned off.

Parameters:

msg

The message text, a null-terminated UTF-8 string.

Referenced by ASUserInteractionChecker::logInfo().

ASAPI ASErr(* ASUserInteractionSuite::LogInteractionW)(const ASUnicode *msg)

Sets the log message using a Unicode string.

This message is written to the log file when an alert condition occurs, if user interactivity is turned off.

Parameters:

msg

The message text, a null-terminated UTF-16 string.

ASAPI ASErr(* ASUserInteractionSuite::SetInteractionAllowed)(ASInteractionAllowed allowed)

Sets the level of interaction that is allowed between the application and the user.

The default value is kASInteractWithAll.

Parameters:

allowed

The interaction level constant.

---

The documentation for this struct was generated from the following file:

• ASUserInteraction.h