IFPCHTTPCompressionConfiguration::UnsupportedUserAgents property

Article
08/27/2012

Applies to: desktop apps only

The UnsupportedUserAgents property gets an FPCUserAgents collection that contains the list of User-Agent strings for which a compressed response will not be requested.

This property is read-only.

Syntax

HRESULT get_UnsupportedUserAgents(
  IFPCUserAgents **ppUnsupportedUserAgents
);

' Data type: FPCUserAgents

Property UnsupportedUserAgents( _
  ByVal ppUnsupportedUserAgents As IFPCUserAgents _
) As FPCUserAgents

Property value

Reference to an FPCUserAgents collection that contains the list of User-Agent strings for which a compressed response will not be requested.

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. User-Agent strings can be added or removed by calling the methods of the FPCUserAgents collection retrieved (the IFPCUserAgents interface retrieved in C++).

The User-Agent strings stored in this property may include wildcard characters (*). A User-Agent string that begins and ends with a wildcard character represents any User-Agent string that contains the substring between the wildcard characters.

This property cannot be accessed through Forefront TMG Management.

Examples

This VBScript script displays the list of User-Agent strings for which compressed content will not be requested for an array. This script can be run only on an array member.

' 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 userAgents        ' An FPCUserAgents collection
Dim userAgent         ' A String
' Get references to the array object 
' and the collection of User-Agent strings.
Set isaArray = root.GetContainingArray()
With isaArray.ArrayPolicy.WebProxy.HTTPCompressionConfiguration
    Set userAgents = .UnsupportedUserAgents
End With
' Display the unsupported User-Agent strings.
For Each userAgent In userAgents
    WScript.Echo userAgent
Next

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