IFPCPolicyRules::AddAccessRule method

Article
08/27/2012

Applies to: desktop apps only

The AddAccessRule method creates a new FPCPolicyRule object representing an access rule in the collection and returns a reference to it.

Syntax

HRESULT AddAccessRule(
  [in]   BSTR Name,
  [out]  IFPCPolicyRule **ppNewRule
);

FPCPolicyRules.AddAccessRule( _
  ByVal Name As String, _
  ByRef ppNewRule _
) As FPCPolicyRule

Parameters

Name [in]

C++ Required. BSTR that specifies the name of the new access rule.

VB Required. String that specifies the name of the new access rule.
ppNewRule [out]
Address of an interface pointer that on return points to an IFPCPolicyRule interface representing the new access rule.

Return value

C++

This method returns one of the following:

S_OK, indicating that the operation succeeded.
An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

VB

This method returns a reference to the FPCPolicyRule object if the operation is successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

The name assigned to the new rule must be unique. If the AddAccessRule method is called with the name of an existing policy rule, the method fails.

An access rule defines the action that will be taken when specific users attempt to access specific sites or content through the Forefront TMG computer. The access rule defined by the FPCPolicyRule object (IFPCPolicyRule interface in C++) created can be configured by setting the properties of the FPCAccessProperties object accessed through the AccessProperties property.

When an enterprise with central array management is deployed, the following restrictions apply.

An access rule that allows traffic cannot be created in an array policy if the enterprise administrator sets the EnableAllowRules property of the FPCPolicyAssignment object (IFPCPolicyAssignment interface in C++) for the array to False (VARIANT_FALSE in C++).
An access rule that allows traffic cannot be created in an array policy if the enterprise administrator sets the EnableDenyRules property of the FPCPolicyAssignment object (IFPCPolicyAssignment interface in C++) for the array to False (VARIANT_FALSE in C++).

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

Share via