Action Property (MAPISession Control)

       

Determines what action is performed when the MAPISession control is invoked. This property is not available at design time. Setting the Action property at run time invokes the control. The Action property is write-only at run time.

Note   The Action property is included for compatibility with earlier versions of Visual Basic. For additional functionality, use the new methods listed in the Methods list for the MAPISession control.

Syntax

object.Action [ = value ]

The Action property syntax has these parts:

Part Description
object An object expression that evaluates to an object in the Applies To list.
value An integer expression specifying the action to perform, as described in Settings.

Settings

The settings for value are:

Constant Value Description
mapSignOn 1 Logs user into the account specified by the UserName and Password properties and provides a session handle to the underlying message subsystem. The session handle is stored in the SessionID property.

Depending on the value of the NewSession property, the session handle may refer to a newly created session or an existing session.

mapSignOff 2 Ends the messaging session and signs the user off the specified account.

Remarks

This property is used to select between signing on and signing off from a messaging session. When signing on, a session handle is returned in the SessionID property.

Data Type

Integer