IncludeStatus Property of the IFPCRef Interface

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.

[C++]

HRESULT get_IncludeStatus(
	FpcIncludeStatus* pIncludeStatus
);

Parameters

pIncludeStatus: Pointer to a variable that on return receives a value from the FpcIncludeStatus enumerated type specifying whether the referenced object is included in or excluded from the list of items to which a rule applies.

Return Value

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

[Visual Basic]

Property IncludeStatus 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.

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

Client	Requires Windows Vista or Windows XP.
Server	Requires Windows Server 2008.
Version	Requires Forefront Threat Management Gateway (TMG).
IDL	Declared in Msfpccom.idl.
DLL	Requires Msfpccom.dll.