This documentation is archived and is not being maintained.

ActionKick Property

Exchange Server 2003

ActionKick Property

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

The ActionKick property, when True, specifies that the link can trigger its queues to retry transmitting waiting messages immediately, instead of waiting for the default protocol timeout before retrying the transmission. The ActionKick property corresponds to the first bit (0x00000001) of the SupportedLinkActions property. The ActionKick property is read-only.

Applies To

The ActionKick property is a member of the ExchangeLink Class.

Instance Path

The ActionKick property appears on instances of the \\COMPUTERNAME\ROOT\cimv2\applications\exchange:ExchangeLink class.

MOF Syntax

boolean ActionKick;

Qualifiers

This property has no qualifiers.

Remarks

This property indicates that a link can be forced to retry transmission. Forcing retransmission is useful to restart message flow to a link destination server that has been recently returned to service.

VBScript Example

The following example shows how to retrieve a list of ExchangeLink instances, and how to retrieve the ActionKick property for each instance.

'===============================================================
' Name:      ShowLinks_ActionKick
' Purpose:   Display each Link found for Exchange server specified,
'            and show the ActionKick property for the ExchangeLink
'            objects
' Input:     strComputerName [string] the computer to access
' Output:    Displays the name of each Link and ActionKick
'===============================================================
Public Sub ShowLinks_ActionKick ( strComputerName )

Const cWMINameSpace = "root/cimv2/applications/exchange"
Const cWMIInstance = "ExchangeLink"

Dim strWinMgmts          ' Connection string for WMI
Dim objWMIExchange       ' Exchange Namespace WMI object
Dim listExchangeLinks    ' ExchangeLink collection
Dim objExchangeLink      ' A single ExchangeLink WMI object

' Create the object string, indicating WMI (winmgmts), using the
' current user credentials (impersonationLevel=impersonate),
' on the computer passed to the function in strComputerName, and
' using the CIM namespace for the ExchangeLink provider.
strWinMgmts = "winmgmts:{impersonationLevel=impersonate}!//" & _
   strComputerName & "/" & cWMINameSpace
'
' Get an object using the string you just created.
Set objWMIExchange =  GetObject(strWinMgmts)
'
' The links that currently exist appear as a list of
' ExchangeLink instances in the Exchange namespace.
Set listExchangeLinks = objWMIExchange.InstancesOf(cWMIInstance)
'
' Iterate through the list of ExchangeLink objects.
For each objExchangeLink in listExchangeLinks
   '
   ' Display the value of the LinkName property.
   WScript.echo "LinkName = [" & _
      TypeName(objExchangeLink.LinkName) & "] " & _
      objExchangeLink.LinkName
   '
   ' Display the value of the ActionKick property.
   WScript.echo "    ActionKick                 = " & _
      "[" & TypeName(objExchangeLink.ActionKick) & "] " & _
      objExchangeLink.ActionKick
   '
   ' Move to the next ExchangeLink.
Next
end Sub

Show: