CanEnumRecipient Property

CanEnumRecipient 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 CanEnumRecipient property, when True, specifies that the queue can enumerate the recipients of messages that it has waiting for transmission. The CanEnumRecipient property corresponds to the fourth bit (0x00000004) of the MsgEnumFlagsSupported property. The CanEnumRecipient property is read-only.

Applies To

The CanEnumRecipient property is a member of the ExchangeQueue Class.

Instance Path

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

MOF Syntax

boolean CanEnumRecipient;

Qualifiers

This property has no qualifiers.

VBScript Example

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

'===============================================================
' Name:      ShowQueue_CanEnumRecipient
' Purpose:   Display each Queue found for the Exchange server,
'            and show the CanEnumRecipient property on the
'            ExchangeQueue objects.
' Input:     strComputerName [string] the computer to access
' Output:    Displays the name of each Queue and the
'            CanEnumRecipient property.
'===============================================================
Public Sub ShowQueue_CanEnumRecipient ( strComputerName )

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

Dim strWinMgmts              ' Connection string for WMI
Dim objWMIExchange           ' Exchange Namespace WMI object
Dim listQueues               ' ExchangeQueue collection
Dim objExchangeQueue         ' A single ExchangeQueue 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 ExchangeQueue provider.
strWinMgmts = "winmgmts:{impersonationLevel=impersonate}!//" & _
   strComputerName & "/" & cWMINameSpace
'
' Get an object using the string you just created.
Set objWMIExchange =  GetObject(strWinMgmts)
'
' The Resources that currently exist appear as a list of
' ExchangeQueue instances in the Exchange namespace.
Set listQueues = objWMIExchange.InstancesOf(cWMIInstance)
'
' Were any ExchangeQueue Instances returned?
if (listQueues.count > 0) then
  ' If yes, do the following:
  ' Iterate through the list of ExchangeQueue objects.
  For each objExchangeQueue in listQueues
     '
     ' Display the value of the LinkName property.
     WScript.echo "LinkName = " & _
      "[" & TypeName(objExchangeQueue.LinkName) & "] " & _
       objExchangeQueue.LinkName
     '
     ' Display the value of the CanEnumRecipient property.
     WScript.echo "    CanEnumRecipient                         = [" & _
       TypeName(objExchangeQueue.CanEnumRecipient) & "] " & _
      objExchangeQueue.CanEnumRecipient
     '
     ' Move to the next ExchangeQueue.
  Next
else
  ' If no ExchangeQueue instances were returned,
  ' display that.
  WScript.Echo "No ExchangeQueue instances were returned."
end if
end Sub

Send us your feedback about the Microsoft Exchange Server 2003 SDK.

Build: June 2007 (2007.618.1)

© 2003-2006 Microsoft Corporation. All rights reserved. Terms of use.