Item Method of the IFPCSignaledAlerts Interface

Syntax

HRESULT Item(
  [in]			VARIANT IndexOrEventGuid,
  [in, optional]  VARIANT AdditionalKey,
  [in, optional]  VARIANT Server,
  [out]		 IFPCLDTEntry** pItem
);

Parameters

IndexOrEventGuid

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

AdditionalKey

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.

Server

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

Address of an interface pointer that on return points to the IFPCSignaledAlert interface requested.

Return Value

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.

Syntax

Function Item( _
  ByVal IndexOrEventGuid As Variant, _
  [ ByVal AdditionalKey As Variant ], _
  [ ByVal Server As Variant ] _
) As FPCLDTEntry

Parameters

IndexOrEventGuid

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

AdditionalKey

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

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.

Return Value

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.