IFPCSessionsMonitor::Item method

Article
08/27/2012

Applies to: desktop apps only

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.

Syntax

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

FPCSessionsMonitor.Item( _
  ByVal index As Long, _
  ByRef pItem As IFPCSessionsMonitorEntry _
) As FPCSessionsMonitorEntry

Parameters

index [in]
Required. One-based index of the object to retrieve.
pItem [out]
Address of an interface pointer that on return points to the IFPCSessionsMonitorEntry interface requested.

Return value

C++

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.

VB

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

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl
DLL	Msfpccom.dll

Share via