GetContainingArray Method of the IFPC Interface

The GetContainingArray method retrieves the FPCArray object (IFPCArray interface in C++) that represents the array containing the current computer.

Note  This method is only relevant when executed on a computer which runs the Microsoft Firewall service.



HRESULT GetContainingArray(
  [out]  IFPCArray** 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:

[Visual Basic]


Function GetContainingArray() As FPCArray


This method has no 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:

Example Code

The following Visual Basic code example retrieves the name of the array containing the current computer by means of the GetContainingArray method.
Dim root As New FPCLib.FPC
Dim arrayName As String
arrayName = root.GetContainingArray.Name


This method cannot be used to retrieve an FPCArray object on a remote management computer. For information about retrieving an FPCArray object on a remote management computer, see Retrieving an Array Object.

When this method is called for remote management, it should be called only on a computer that is connected to a Configuration Storage server by a user who has the permissions needed to access information stored on the Configuration Storage server. A computer can be connected to a Configuration Storage server by calling ConnectToConfigurationStorageServer with a valid user name and password before calling this method. This method can also be used to supply valid user credentials for accessing information about the Configuration Storage server.

This method supports multiple arrays (not available in Forefront TMG Medium Business Edition). Assume, for example, that there are two arrays, Array1 and Array2. Array1 contains two computers, A and B. Array2 contains computer C. If you call GetContainingArray on computer A, the method returns Array1. If you call GetContainingArray on computer C, the method returns Array2.


Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).

Declared in Msfpccom.idl.


Requires Msfpccom.dll.

See Also


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.