Add Method of the IFPCEEArrays Interface

Syntax

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

Parameters

Array

Required. BSTR that specifies name of the new array.

Guid

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

SaveImmediately

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.

ppNewArray

Address of an interface pointer that on return points to the new IFPCArray interface created.

Return Value

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.

Syntax

Function Add( _
  ByVal Array As String, _
  [ ByVal Guid As String ], _
  [ ByVal SaveImmediately As Boolean ] _
) As FPCArray

Parameters

Array

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

Guid

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

SaveImmediately

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.

Return Value

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.