[C++]
The Item method retrieves the requested IFPCSignaledAlert
interface from the collection.
HRESULT Item(
VARIANT IndexOrEventGuid,
VARIANT AdditionalKey,
VARIANT Server,
IFPCLDTEntry** ppItem
);
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] Index specifying the subevent for which the
alert is issued. This parameter should be set only if the
Index parameter contains an event GUID. For more
information, see IFPCAlert::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.
- ppItem
- [out] Address of an interface pointer that on return points to
the IFPCSignaledAlert interface requested.
Return Values
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.
[Visual Basic]
The Item method retrieves the requested FPCSignaledAlert object
from the collection.
Function Item( _
ByVal IndexOrEventGuid As Variant, _
[ ByVal AdditionalKey As Variant ], _
[ ByVal Server As Variant ] _
) 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] Index specifying the subevent for which the
alert is issued. This parameter should be set only if the
Index 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.
Return Values
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.