Share via

Add Method of the IFPCEventDefinitions Interface

  • Article

The Add method creates a new FPCEventDefinition object in the collection and returns a reference to it. A new event definition can be created only through the Forefront TMG administration COM objects, not in Forefront TMG Management.

C++

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.

Visual Basic

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.

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

FPCEventDefinitions

Send comments about this topic to Microsoft

Build date: 6/30/2010