AddAccessRule Method of the IFPCPolicyRules Interface
The AddAccessRule method creates a new FPCPolicyRule object representing an access rule in the collection and returns a reference to it.
C++
Syntax
HRESULT AddAccessRule(
[in] BSTR Name,
[out] IFPCPolicyRule** ppNewRule
);
Parameters
Name
Required. BSTR that specifies the name of the new access rule.ppNewRule
Address of an interface pointer that on return points to an IFPCPolicyRule interface representing the new access rule.
Return Value
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.
Visual Basic
Syntax
Function AddAccessRule( _
ByVal Name As String _
) As FPCPolicyRule
Parameters
- Name
Required. String that specifies the name of the new access rule.
Return Value
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
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. |
See Also
Send comments about this topic to Microsoft
Build date: 6/30/2010