IFPCSignaledAlerts::Item method

Applies to: desktop apps only

The Item method retrieves the requested FPCSignaledAlert object (IFPCSignaledAlert interface in C++) from the collection.

Syntax

HRESULT Item(
  [in]            VARIANT IndexOrEventGuid,
  [in, optional]   AdditionalKey,
  [in, optional]  VARIANT AdditionalKey,
  [in, optional]  VARIANT Server,
  [out]           IFPCLDTEntry **pItem
);
FPCSignaledAlerts.Item( _
  ByVal IndexOrEventGuid As Variant, _
  [ ByVal AdditionalKey As Variant ], _
  [ ByVal AdditionalKey ], _
  [ ByVal Server As Variant ], _
  ByRef pItem As IFPCLDTEntry _
) As FPCLDTEntry

Parameters

  • IndexOrEventGuid [in]
    Required. Globally unique identifier (GUID) of the event for which the alert is issued or one-based index of the object to retrieve.

  • AdditionalKey [in, optional]

    C++

    Index specifying the subevent for which the alert is issued. This parameter should be set only if the IndexOrEventGuid parameter contains an event GUID. For more information, see IFPCAlert::AdditionalKey.

    VB

    Index specifying the subevent for which the alert is issued. This parameter should be set only if the IndexOrEventGuid parameter contains an event GUID. For more information, see FPCAlert.AdditionalKey.

  • Server [in, optional]
    Name of the server that is allowed to issue the alert. This parameter should be set if only a specific server is allowed to issue the alert.

  • pItem [out]
    Address of an interface pointer that on return points to the IFPCSignaledAlert interface requested.

Return value

C++

This method can return one of the following:

  • S_OK, indicating that the operation succeeded.
  • An error message, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

VB

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

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

FPCSignaledAlerts

 

 

Build date: 7/12/2010