This documentation is archived and is not being maintained.

StateFlags Property

Exchange Server 2003

StateFlags 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 StateFlags property specifies the state of the link. The individual bits of this property are available as the link State and Type properties of this class. The StateFlags property is read-only.

Applies To

The StateFlags property is a member of the ExchangeLink Class.

Instance Path

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

MOF Syntax

uint32 StateFlags;

Qualifiers

This property has no qualifiers.

VBScript Example

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

'===============================================================
' Name:      ShowLinks_StateFlags
' Purpose:   Display each Link found for Exchange server specified,
'            and show the StateFlags value, as well as the
'            component bit values for the ExchangeLink objects
' Input:     strComputerName [string] the computer to access
' Output:    Displays the name of each Link, the StateFlags
'            value, and the component bits
'===============================================================
Public Sub ShowLinks_StateFlags ( 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 StateFlags property.
   WScript.echo "    StateFlags                 = " & _
      "[" & TypeName(objExchangeLink.StateFlags) & "] 0x" & _
      Hex(objExchangeLink.StateFlags)
   WScript.echo "        (Least Significant Bit)"
   '
   ' Display the value of the StateActive property.
   WScript.echo "        StateActive                = " & _
      "[" & TypeName(objExchangeLink.StateActive) & "] " & _
      objExchangeLink.StateActive
   '
   ' Display the value of the StateReady property.
   WScript.echo "        StateReady                 = " & _
      "[" & TypeName(objExchangeLink.StateReady) & "] " & _
      objExchangeLink.StateReady
   '
   ' Display the value of the StateRetry property.
   WScript.echo "        StateRetry                 = " & _
      "[" & TypeName(objExchangeLink.StateRetry) & "] " & _
      objExchangeLink.StateRetry
   '
   ' Display the value of the StateScheduled property.
   WScript.echo "        StateScheduled             = " & _
      "[" & TypeName(objExchangeLink.StateScheduled) & "] " & _
      objExchangeLink.StateScheduled
   '
   ' Display the value of the StateRemote property.
   WScript.echo "        StateRemote                = " & _
      "[" & TypeName(objExchangeLink.StateRemote) & "] " & _
      objExchangeLink.StateRemote
   '
   ' Display the value of the StateFrozen property.
   WScript.echo "        StateFrozen                = " & _
      "[" & TypeName(objExchangeLink.StateFrozen) & "] " & _
      objExchangeLink.StateFrozen
   '
   ' Display the value of the TypeRemoteDelivery property.
   WScript.echo "        TypeRemoteDelivery         = " & _
     "[" & TypeName(objExchangeLink.TypeRemoteDelivery) & "] " & _
      objExchangeLink.TypeRemoteDelivery
   '
   ' Display the value of the TypeLocalDelivery property.
   WScript.echo "        TypeLocalDelivery          = " & _
      "[" & TypeName(objExchangeLink.TypeLocalDelivery) & "] " & _
      objExchangeLink.TypeLocalDelivery
   '
   ' Display the value of the TypePendingRouting property.
   WScript.echo "        TypePendingRouting         = " & _
      "[" & TypeName(objExchangeLink.TypePendingRouting) & "] " & _
      objExchangeLink.TypePendingRouting
   '
   ' Display the value of the TypePendingCategorization property.
   WScript.echo "        TypePendingCategorization  = " & _
      "[" & TypeName(objExchangeLink.TypePendingCategorization) & "] " & _
      objExchangeLink.TypePendingCategorization
   '
   ' Display the value of the TypeCurrentlyUnreachable property.
   WScript.echo "        TypeCurrentlyUnreachable   = " & _
      "[" & TypeName(objExchangeLink.TypeCurrentlyUnreachable) & "] " & _
      objExchangeLink.TypeCurrentlyUnreachable
   '
   ' Display the value of the TypeDeferredDelivery property.
   WScript.echo "        TypeDeferredDelivery       = " & _
      "[" & TypeName(objExchangeLink.TypeDeferredDelivery) & "] " & _
      objExchangeLink.TypeDeferredDelivery
   '
   ' Display the value of the TypeInternal property.
   WScript.echo "        TypeInternal               = " & _
      "[" & TypeName(objExchangeLink.TypeInternal) & "] " & _
      objExchangeLink.TypeInternal
   '
   ' Display the value of the TypePendingSubmission property
   ' added in Service Pack 2.
'   WScript.echo "        TypePendingSubmission      = " & _
'      "[" & TypeName(objExchangeLink.TypePendingSubmission) & "] " & _
'      objExchangeLink.TypePendingSubmission

   WScript.echo "        (Most Significant Bit)"
   '
   ' Move to the next ExchangeLink.
Next
end Sub

Show: