SetStopServices Method of the IFPCAlertActions Interface

The SetStopServices method creates a new stop-services action in the collection, or updates the stop-services action if it already exists, and then returns a reference to it.

C++

Syntax

HRESULT SetStopServices(
  [in]   BSTR ActionName,
  [in]   FpcServices Services,
  [out]  IFPCAlertAction** ppNewAction
);

Parameters

• ActionName
  Required. String value that specifies the name of the action. This name is used to identify the action in the FPCAlertActions collection if it already exists.

• Services
  Required. Value from the FpcServices enumerated type that specifies which service to stop.

• ppNewAction
  Address of an interface pointer that on return points to the IFPCAlertAction interface for the new or updated stop-services action.

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 SetStopServices( _
  ByVal ActionName As String, _
  ByVal Services As FpcServices _
) As FPCAlertAction

Parameters

• ActionName
  Required. String value that specifies the name of the action. This name is used to identify the action in the FPCAlertActions collection if it already exists.

• Services
  Required. Value from the FpcServices enumerated type that specifies which service to stop.

Return Value

This method returns a reference to an FPCAlertAction 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

FPCAlertActions

Send comments about this topic to Microsoft

Build date: 6/30/2010