Share via

IFPCSessionsMonitor::ItemAsync method

  • Article

Applies to: desktop apps only

The ItemAsync method retrieves the requested FPCSessionsMonitorEntry object (IFPCSessionsMonitorEntry interface in C++) from the collection if it is available, returns null and sets the error code to E_PENDING if the requested object cannot be found immediately, or returns null and sets an error code if the operation fails or another error occurs. In C++, this method returns E_PENDING if the requested interface cannot be found immediately, or it returns an error code if the operation fails or another error occurs.

Syntax

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

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

Parameters

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

  • pItem
    Address of an interface pointer that on return points to the IFPCSessionsMonitorEntry interface requested if the call is successful, or to a null interface if the requested interface cannot be found or the operation fails.

Return value

C++

This 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 interface requested was not found.
  • 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 an FPCSessionsMonitorEntry object requested if successful. Otherwise, it returns null and raises an error that can be intercepted by using an error handler. The error code set can be one of the following:

  • S_FALSE, indicating that the query ended before the interface requested was found.
  • E_PENDING, indicating that the interface requested was not found.
  • An error code, indicating that the operation failed or an error occurred 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

See also

FPCSessionsMonitor

 

 

Build date: 7/12/2010