IFPCRef::IncludeStatus property

Article
08/27/2012

Applies to: desktop apps only

The IncludeStatus property gets a value from the FpcIncludeStatus enumerated type that specifies whether the referenced object is included in or excluded from a rule.

This property is read-only.

Syntax

HRESULT get_IncludeStatus(
  FpcIncludeStatus *pIncludeStatus
);

' Data type: FpcIncludeStatus

Property IncludeStatus( _
  ByVal pIncludeStatus As FpcIncludeStatus _
) As FpcIncludeStatus

Property value

Value from the FpcIncludeStatus enumerated type that specifies whether the referenced object is included in or excluded from the list of items to which a rule applies.

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. It is set in the call to the Add or AddScopedItem method of the FPCRefs collection that created the reference.

The value of this property is meaningless for items in some FPCRefs collections, such as the collection accessed through the SpecifiedProtocols property of the FPCAccessProperties object. Here the inclusion of the specified protocols in the rule, or their exclusion from the rule, is indicated by the ProtocolSelectionMethod property.

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