IFPCRefs::Add[C++] | FPCRefs.Add [Visual Basic]

Internet Security and Acceleration Server 2004/2006 SDK

The Add method creates a new FPCRef object in the collection and returns a reference to it.


HRESULT Add(
  BSTR Name,
  FpcIncludeStatus IncludeStatus,
  IFPCRef** ppNewRef );

Parameters

Name
[in] Required. BSTR 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 created.

Return Values

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.

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.

In ISA Server Enterprise Edition, this method creates an FPCRef object that references an item in the same scope (array or enterprise) as the object through which the FPCRefs collection was accessed. The AddScopedItem method can be used to create an FPCRef object that references an item in a specified scope.

The Add method creates a new FPCRef object in the collection and returns a reference to it.


Function Add( _
  ByVal Name As String, _
  ByVal IncludeStatus As FpcIncludeStatus _
) As FPCRef

Parameters

Name
[in] 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.

Return Values

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.

In ISA Server Enterprise Edition, this method creates an FPCRef object that references an item in the same scope (array or enterprise) as the object through which the FPCRefs collection was accessed. The AddScopedItem method can be used to create an FPCRef object that references an item in a specified scope.

Example Code

For VBScript code examples that show how to use this method to add references to networks, URL sets, and protocols for use in access rules, see Adding an Access Rule and Controlling Access by a Schedule and a User Set.

Requirements

Client Requires Windows XP.
Server Requires Windows Server 2003. Requires Windows Server 2003 or Windows 2000 for ISA Server 2004 Standard Edition.
Version Requires Internet Security and Acceleration (ISA) Server 2006 or ISA Server 2004.
IDL

Declared in Msfpccom.idl.

DLL Requires Msfpccom.dll.

See Also

FPCRefs

Show: