Add Method of the IFPCProtocolDefinitions Interface

The Add method creates a new FPCProtocolDefinition object and returns a reference to it.

C++

Syntax

HRESULT Add(
  [in]            BSTR ProtocolName,
  [in, optional]  BSTR ProtocolGuid,
  [in, optional]  long category,
  [out]           IFPCProtocolDefinition** ppNew
);

Parameters

• ProtocolName
  Required. BSTR that specifies the name of the new protocol.

• ProtocolGuid
  BSTR that specifies the globally unique identifier (GUID) of the new protocol. The default value is an empty BSTR.

• category
  A 32-bit integer value that specifies the category or categories to which the new protocol belongs. This value is a bitwise combination of values from the FpcProtocolCategory enumerated type. The default value is fpcProtocolCategoryUserDefined.

• ppNew
  Address of an interface pointer that on return points to the new IFPCProtocolDefinition 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 ProtocolName As String, _
  [ ByVal ProtocolGuid As String ], _
  [ ByVal category As Long ] _
) As FPCProtocolDefinition

Parameters

• ProtocolName
  Required. String that specifies the name of the new protocol.

• ProtocolGuid
  String that specifies the globally unique identifier (GUID) of the new protocol. The default value is an empty string.

• category
  A 32-bit integer value that specifies the category or categories to which the new protocol belongs. This value is a bitwise combination of values from the FpcProtocolCategory enumerated type. The default value is fpcProtocolCategoryUserDefined.

Return Value

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

FPCProtocolDefinitions

Send comments about this topic to Microsoft

Build date: 6/30/2010