Microsoft Internet Security and Acceleration Server 2004 SDK

IFPC::GetContainingArray[C++]

FPC.GetContainingArray [Visual Basic]

[C++]

The GetContainingArray method retrieves the IFPCArray interface that represents the array containing the current computer. 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.

HRESULT GetContainingArray(
  IFPCArray** ppItem
);

Parameters

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

Return Values

This method can return one of the following:

[Visual Basic]

The GetContainingArray method retrieves the FPCArray object that represents the array containing the current computer. 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.

Function GetContainingArray() As FPCArray

Parameters

This method has no parameters.

Return Values

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, an ERROR_FILE_NOT_FOUND is raised if the FPCArray object could not be found because the method was called on a remote administration computer on which the Microsoft Firewall service is not running.

Example Code

The following 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 containingArray As String
containingArray = root.GetContainingArray.Name

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.

See Also

FPC