Share via

Item Method of the IFPCSessionsMonitor Interface

  • Article

The Item method retrieves the requested FPCSessionsMonitorEntry object (IFPCSessionsMonitorEntry interface in C++) from the collection. This method returns only when the requested object (interface in C++) is found, the associated query ends, or an error occurs in the query.

C++

Syntax

HRESULT Item(
  [in]   long index,
  [out]  IFPCSessionsMonitorEntry** pItem
);

Parameters

  • index
    Required. One-based index of the object to retrieve.

  • pItem
    Address of an interface pointer that on return points to the IFPCSessionsMonitorEntry interface requested.

Return Value

The method can return one of the following:

  • S_OK, indicating that the operation succeeded.
  • S_FALSE, indicating that the query ended before the interface requested was found.
  • E_PENDING, indicating that the Index parameter points beyond the end of the collection.
  • An error code, indicating that the operation failed or an error occurred in the query.

If the return value is not S_OK, the [out] parameter returned is a null object.

Visual Basic

Syntax

Function Item( _
  ByVal index As Long _
) As FPCSessionsMonitorEntry

Parameters

  • index
    Required. One-based index of the object to retrieve.

Return Value

This method returns a reference to the FPCSessionsMonitorEntry object requested if successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

This method can retrieve an FPCSessionsMonitorEntry object (IFPCSessionsMonitorEntry interface in C++) that represents an active session that exists when the query starts. If the object requested is not found, the method waits until the associated query ends or an error occurs in the query.

Requirements

Client Requires Windows 7 or Windows Vista.
Server Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version Requires Forefront Threat Management Gateway (TMG) 2010.
IDL

Declared in Msfpccom.idl.
DLL

Requires Msfpccom.dll.

See Also

FPCSessionsMonitor

Send comments about this topic to Microsoft

Build date: 6/30/2010