Add Method of the IFPCEventDefinitions Interface

Syntax

HRESULT Add(
  [in]			BSTR Name,
  [in]			BSTR EventGUID,
  [in, optional]  VARIANT* pAdditionalKeys,
  [out]		 IFPCEventDefinition** ppNewEvent
);

Parameters

Name

Required. BSTR that specifies the name of the new event. The name should be unique in the collection.

EventGUID

Required. String-formatted globally unique identifier (GUID) of the new event.

pAdditionalKeys

Pointer to a VARIANT containing an array of strings that define subevents for the event. The index of each string is the additional key for the corresponding subevent. The additional key with an index equal to 0 is reserved to indicate all of the subevents defined for the event.

ppNewEvent

Address of an interface pointer that on return points to the new IFPCEventDefinition interface created.

Return Value

This method can return one of the following:

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

Syntax

Function Add( _
  ByVal Name As String, _
  ByVal EventGUID As String, _
  [ ByRef AdditionalKeys As Variant ] _
) As FPCEventDefinition

Parameters

Name

Required. String that specifies the name of the new event. The name should be unique in the collection.

EventGUID

Required. String-formatted globally unique identifier (GUID) of the new event.

AdditionalKeys

Array of strings that define subevents for the event. The index of each string is the additional key for the corresponding subevent. The additional key with an index equal to 0 is reserved to indicate all of the subevents defined for the event.

Return Value

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