IFPCEERefs::AddScopedItem method

Article
08/27/2012

Applies to: desktop apps only

The AddScopedItem method creates a new FPCRef object for an item with a specific scope in the collection and returns a reference to it. The scope indicates whether the referenced item is defined for the array or for the enterprise.

Syntax

HRESULT AddScopedItem(
  [in]   FpcItemScope Scope,
  [in]   BSTR Name,
  [in]   FpcIncludeStatus IncludeStatus,
  [out]  IFPCRef **ppNewRef
);

FPCRefs.AddScopedItem( _
  ByVal Scope As FpcItemScope, _
  ByVal Name As String, _
  ByVal IncludeStatus As FpcIncludeStatus, _
  ByRef ppNewRef As IFPCRef _
) As FPCRef

Parameters

Scope [in]
Required. Value from the FpcItemScope enumerated type that specifies the scope of the item that will be referenced by the new object.

Name [in]

C++	Required. BSTR that specifies the name of the item that will be referenced by the new object.
VB	Required. String that specifies the name of the item that will be referenced by the new object.

IncludeStatus [in]
Required. Value from the FpcIncludeStatus enumerated type that specifies whether the referenced item will be included in or excluded from the list of items to which a rule applies.
ppNewRef [out]
Address of an interface pointer that on return points to the new IFPCRef interface added.

Return value

C++

This method can return 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 FPCRef object added if the call is successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

The IncludeStatus parameter must be set even when the collection is accessed through a property for which this parameter is meaningless, such as 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.

When the array is not joined to the enterprise, the Scope parameter must be set fpcArrayScope.

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