_NewEnum Property of the IFPCAlertActions Interface

Article
08/13/2010

The _NewEnum property gets an enumerator object for the collection. An enumerator object provides serial access to the elements of the collection.

C++

HRESULT get__NewEnum(
    IUnknown* ppEnum
);

Parameters

ppEnum
Address of an interface pointer that on return points to the IUnknown interface of an enumerator object that implements an IEnumVARIANT interface for the collection. An interface pointer to the IEnumVARIANT interface of the enumerator object can be retrieved by calling QueryInterface on the IUnknown interface returned.

Return Value

This property method returns S_OK if the call is successful; otherwise, it returns an error code.

Visual Basic

Property _NewEnum As IUnknown

Property Value

Reference to an enumerator object that provides serial access to the elements of the collection.

Example Code

This VBScript script displays the names of all the actions that will be taken when the first alert in the collection of alerts defined for an FPCArray object is issued. It does not include error handling.

' Create the root object.
Dim root  ' The FPCLib.FPC root object
Set root = CreateObject("FPC.Root")
' Declare the other objects needed.
Dim isaArray      ' An FPCArray object
Dim alertActions  ' An FPCAlertActions collection
Dim alertAction   ' An FPCAlertAction object
Dim alerts        ' An FPCAlerts collection
Dim alert         ' An FPCAlert object
' Get references to the array object 
' and the alerts collection.
Set isaArray = root.GetContainingArray()
Set alerts = isaArray.Alerts
' If at least one alert is defined in the alerts 
' collection, display the names of the alert actions
' defined for it.
On Error Resume Next
Set alert = alerts.Item(1)
Set alertActions = alert.Actions
If Err.Number = 0 Then
    For Each alertAction In alertActions
        WScript.Echo "Alert action name: " + alertAction.Name 
    Next
End If

Remarks

This property is read-only.

In Visual Basic and VBScript, this property is used implicitly in For Each...In...Next constructs.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.
DLL	Requires Msfpccom.dll.

Share via