FPCAccessProperties Object

The FPCAccessProperties object represents the properties of a policy rule that was created as an access rule using the AddAccessRule method.

This object is accessed through the AccessProperties property of the FPCPolicyRule object representing an access rule.

Dd435818.bkbutton(en-us,MSDN.10).png Click here to see the Forefront TMG object hierarchy.

Methods

The FPCAccessProperties object does not define any methods.

Properties

The FPCAccessProperties object defines the following properties.

Property Description

AppliesToContentMethod

Gets or sets a value from the FpcAppliesToContentMethodType enumerated type that indicates whether the rule applies to all types of content or only to specified types of content.

ContentTypeSetsUsed

Gets an FPCRefs collection that contains references to the FPCContentTypeSet objects defining the content type sets to which the rule applies.

CustomMessageText

Gets or sets the text to be displayed in the access denied error page if displaying custom text is enabled.

DestinationDomainNameSets

Gets an FPCRefs collection that contains references to the FPCDomainNameSet collections defining the destination domain name sets included in or excluded from the destinations to which the rule applies.

DestinationSelectionIPs

Gets an FPCSelectionIPs object that specifies the complete set of destination IP addresses to which the rule applies.

DisplayCustomMessageText

Gets or sets a Boolean value that indicates whether the text specified in the CustomMessageText property will be displayed in the access denied error page.

DisplayUrlCategory

Gets or sets a Boolean value that indicates whether the URL category of the request will be displayed in the access denied error page.

EnableUserOverride

Gets or sets a Boolean value that indicates whether user override is enabled for the rule. (This property is introduced in Forefront TMG 2010 SP 1.)

EnableUserOverrideTimeout

Gets or sets a Boolean value that indicates whether user override of the rule times out after a specified time. (This property is introduced in Forefront TMG 2010 SP 1.)

ProtocolSelectionMethod

Gets or sets a value from the FpcProtocolSelectionType enumerated type that indicates whether the rule applies to all IP traffic, only to certain protocols, or to all IP traffic except certain protocols.

RedirectUrl

Gets or sets the URL to which HTTP requests blocked by the rule will be redirected.

SpecifiedProtocols

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.

UrlCategories

Gets an FPCRefs collection that contains references to the FPCUrlCategory objects defining the URL categories to which the rule applies.

UrlCategorySets

Gets an FPCRefs collection that contains references to the FPCUrlCategorySet objects defining the URL category sets to which the rule applies.

URLSets

Gets an FPCRefs collection that contains references to the FPCURLSet collections defining the URL sets included in or excluded from the destinations to which the rule applies.

UserOverrideTimeoutMinutes

Gets or sets the time, in minutes, after which user override of the rule times out and access to the destination is re-evaluated. (This property is introduced in Forefront TMG 2010 SP 1.)

UserSets

Gets an FPCRefs collection that contains references to the FPCUserSet collections defining the user sets included in or excluded from the users to which the rule applies.

Interfaces for C++ Programming

This object implements the IFPCAccessProperties, IFPCAccessProperties2, and IFPCAccessProperties3 interfaces.

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.

See Also

COM Objects

Send comments about this topic to Microsoft

Build date: 6/30/2010