IFPCUserAgentMappings::_NewEnum property

Article
08/27/2012

Applies to: desktop apps only

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

This property is read-only.

Syntax

HRESULT get__NewEnum(
  IUnknown *ppEnum
);

' Data type: IUnknown

Property _NewEnum( _
  ByVal ppEnum As IUnknown _
) As IUnknown

Property value

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

Error codes

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

Remarks

This property is read-only.

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

Examples

This VBScript script retrieves the collection of User-Agent mappings defined in a Forefront TMG array and displays the User-Agent header, the type of authentication specified, and an indication of whether the mapping is enabled for each User-Agent mapping in the collection.

Const fpcFbaHTML4 = 0
Const fpcFbaCHTML = 1
Const fpcFbaXHTML_MP = 2
Const fpcFbaHTTPBASIC = 3
' Create the root obect.
Dim root  ' The FPCLib.FPC root object
Set root = CreateObject("FPC.Root")
' Declare the other objects needed.
Dim isaArray   ' An FPCArray object
Dim mappings   ' An FPCUserAgentMappings collection
Dim mapping    ' An FPCUserAgentMapping object
Dim authType   ' A String
Dim colSpace1  ' A String
Dim colSpace2  ' A String
Dim isEnabled  ' A String
' Get references to the array object and
' the User-Agent mappings collection.
Set isaArray = root.GetContainingArray()
Set mappings = isaArray.RuleElements.UserAgentMappings
' Display the User-Agent mappings defined in the array.
If mappings.Count > 0 Then
    WScript.Echo "No." & vbTab  & "User-Agent headers" _
                 & vbTab & "Authentication type" _
                 & vbTab & "Enabled/disabled" & vbCrLf
    For Each mapping In mappings
        Select Case mapping.FBAFormsType
            Case fpcFbaHTML4 
                authType = "HTML 4.01 forms" 
            Case fpcFbaCHTML 
                authType = "cHTML forms" 
            Case fpcFbaXHTML_MP 
                authType = "XHTML-MP forms" 
            Case fpcFbaHTTPBASIC 
                authType = "Basic authentication" 
        End Select
        If Len(mapping.UserAgent) < 8 Then
            colSpace1 = vbTab & VbTab & vbTab
        Else 
            colSpace1 = vbTab & vbTab
        End If
        If authType = "Basic authentication" Then
            colSpace2 = vbTab
        Else 
            colSpace2 = vbTab & vbTab
        End If
        If mapping.Enabled = True Then
            isEnabled = "Enabled"
        Else 
            isEnabled = "Disabled"
        End If
        WScript.Echo mapping.order & vbTab & mapping.UserAgent _
                     & colSpace1 & authType & colSpace2 & isEnabled
    Next
Else
    WScript.Echo "No User-Agent mappings are defined."
End If

Requirements

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl
DLL	Msfpccom.dll