IFPCEEArrays::Add method

Article
08/27/2012

Applies to: desktop apps only

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

Syntax

HRESULT Add(
  [in]            BSTR Array,
  [in, optional]  BSTR Guid,
  [in, optional]  VARIANT_BOOL SaveImmediately,
  [out]           IFPCArray **ppNewArray
);

FPCArrays.Add( _
  ByVal Array As String, _
  [ ByVal Guid As String ], _
  [ ByVal SaveImmediately As Boolean ], _
  ByRef ppNewArray As IFPCArray _
) As FPCArray

Parameters

Array [in]

C++ Required. BSTR that specifies name of the new array.

VB Required. String that specifies the name of the new array.

Guid [in, optional]

C++	BSTR that specifies the globally unique identifier (GUID) of the new array. The default value is an empty BSTR.
VB	String that specifies the globally unique identifier (GUID) of the new array. The default value is an empty string.

SaveImmediately [in, optional]

C++	Boolean value that indicates whether to create the array directly in the stored configuration and eliminate the need for calling the Save method to write the changes to persistent storage. The default value is VARIANT_FALSE.
VB	Boolean value that indicates whether to create the array directly in the stored configuration and eliminate the need for calling the Save method to write the changes to persistent storage. The default value is False.

ppNewArray [out]
Address of an interface pointer that on return points to the new IFPCArray interface created.

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 an FPCArray object if successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

This method is available only in Forefront TMG Enterprise Edition.

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