IFPCProtocolDefinitions::Add method

  • Article

Applies to: desktop apps only

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

Syntax

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

FPCProtocolDefinitions.Add( _
  ByVal ProtocolName As String, _
  [ ByVal ProtocolGuid As String ], _
  [ ByVal category As Long ], _
  ByRef ppNew As IFPCProtocolDefinition _
) As FPCProtocolDefinition

Parameters

  • ProtocolName [in]

    C++ Required. BSTR that specifies the name of the new protocol.
    VB Required. String that specifies the name of the new protocol.

  • ProtocolGuid [in, optional]

    C++ BSTR that specifies the globally unique identifier (GUID) of the new protocol. The default value is an empty BSTR.
    VB String that specifies the globally unique identifier (GUID) of the new protocol. The default value is an empty string.

  • category [in, optional]
    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 [out]
    Address of an interface pointer that on return points to the new IFPCProtocolDefinition interface created.

Return value

C++

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.

VB

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

Minimum supported client

 Windows Vista

Minimum supported server

 Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

 Forefront Threat Management Gateway (TMG) 2010

IDL

 Msfpccom.idl

DLL

 Msfpccom.dll

See also

FPCProtocolDefinitions

 

 

Build date: 7/12/2010