Share via

ItemAsync Method of the IFPCLogContent Interface

  • Article

The ItemAsync method retrieves the requested FPCLogEntry object (IFPCLogEntry 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.

C++

Syntax

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

Parameters

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

  • pItem
    Address of an interface pointer that on return points to the IFPCLogEntry 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

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.

Visual Basic

Syntax

Function ItemAsync( _
  ByVal index As Long _
) As FPCLogEntry

Parameters

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

Return Value

This method returns a reference to the FPCLogEntry 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

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

FPCLogContent

Send comments about this topic to Microsoft

Build date: 6/30/2010