SpecifiedProtocols Property of the IFPCAccessProperties Interface

Article
08/13/2010

The SpecifiedProtocols property gets an FPCRefs collection that contains references to the FPCProtocolDefinition objects defining the protocols to which the rule applies or the protocols that are excluded from the rule.

C++

HRESULT get_SpecifiedProtocols(
    IFPCRefs** ppRefs
);

Parameters

ppRefs
Address of an interface pointer that on return points to an IFPCRefs interface that represents the collection of references to the protocols to which the rule applies or the protocols that are excluded from the rule.

Return Value

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

Visual Basic

Property SpecifiedProtocols As FPCRefs

Property Value

Reference to an FPCRefs collection that contains references to the protocols to which the rule applies or the protocols that are excluded from the rule.

Example Code

The following Visual Basic code illustrates the use of the SpecifiedProtocols property.

  Dim root As New FPCLib.FPC
  Dim containingArray As FPCArray
  Dim policyRules As FPCPolicyRules
  Dim newRule As FPCPolicyRule  
  Set containingArray = root.GetContainingArray
  Set policyRules = containingArray.ArrayPolicy.PolicyRules
  Set newRule = policyRules.AddAccessRule("All Web Access")
  newRule.Action = fpcActionAllow
  newRule.Description = "Basic Web access to Everyone"
  newRule.Enabled = True
  newRule.AccessProperties.ProtocolSelectionMethod = fpcSpecifiedProtocols
  newRule.AccessProperties.SpecifiedProtocols.Add ("HTTP", fpcInclude)
  newRule.AccessProperties.SpecifiedProtocols.Add ("HTTPS", fpcInclude)
  newRule.SetAppliesAlways
  policyRules.Save

Remarks

This property is read-only. It can be modified by calling the methods of the FPCRefs collection retrieved (the IFPCRefs interface retrieved in C++).

The ProtocolSelectionMethod property indicates whether the rule applies to all protocols, to the protocols referenced by this property, or to all protocols except the protocols referenced by this property.

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.