GetContainingArray Method of the IFPC Interface

Syntax

HRESULT GetContainingArray(
  [out]  IFPCArray** ppItem
);

Parameters

ppItem

Address of an interface pointer that on return points to the IFPCArray interface that represents the containing array.

Return Value

This method can return one of the following:

• S_OK, indicating that the operation succeeded.
• ERROR_FILE_NOT_FOUND, indicating that the IFPCArray interface could not be found because the method was called on a remote management computer or a Configuration Storage server on which the Microsoft Firewall service is not installed. In this case, the [out] parameter returned is a null object.
• E_FPC_NOT_CONNECTED_TO_ENTERPRISE, indicating that the method was called on a remote Forefront TMG management computer that does not have the Firewall service installed and has not been connected to a Configuration Storage server, or that the user (for example, a user logged on as a local administrator) does not have the permissions needed to access information stored on the remote Configuration Storage server. In this case, the [out] parameter returned is a null object.
• An error code indicating that the operation failed. In this case, the [out] parameter returned is a null object.

Syntax

Function GetContainingArray() As FPCArray

Parameters

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. In particular, the following errors may be raised:

• ERROR_FILE_NOT_FOUND, indicating that the FPCArray object could not be found because the method was called on a remote management computer or a Configuration Storage server on which the Microsoft Firewall service is not installed.
• E_FPC_NOT_CONNECTED_TO_ENTERPRISE, indicating that the method was called on a remote Forefront TMG management computer that does not have the Firewall service installed and has not been connected to a Configuration Storage server, or that the user (for example, a user logged on as a local administrator) does not have the permissions needed to access information stored on the remote Configuration Storage server.

Example Code

Dim root As New FPCLib.FPC
Dim arrayName As String
arrayName = root.GetContainingArray.Name