AddScopedItem Method of the IFPCEERefs Interface

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.

[C++]

Syntax

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

Parameters

Scope

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

Name
Required. BSTR that specifies the name of the item that will be referenced by the new object.
IncludeStatus

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

Address of an interface pointer that on return points to the new IFPCRef interface added.

Return Value

This method can return one of the following:

[Visual Basic]

Syntax

Function AddScopedItem( _
  ByVal Scope As FpcItemScope, _
  ByVal Name As String, _
  ByVal IncludeStatus As FpcIncludeStatus _
) As FPCRef

Parameters

Scope

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

Name
Required. String that specifies the name of the item that will be referenced by the new object.
IncludeStatus

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.

Return Value

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

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.

See Also

FPCRefs


Send comments about this topic to Microsoft

Build date: 11/30/2009

 

© 2008 Microsoft Corporation. All rights reserved.