Share via

IFPCProtocolMessageDefinitions::Add method

  • Article

Applies to: desktop apps only

The Add method creates a new FPCProtocolMessageDefinition object in the collection and returns a reference to it.

Syntax

HRESULT Add(
  BSTR Name,
  String Name,
  FpcProtocolMessageDefinitionTransportProtocol Protocol,
  FpcProtocolMessageDefinitionTransportProtocol Protocol,
  [out]  IFPCProtocolMessageDefinition **ppDefinition
);

FPCProtocolMessageDefinitions.Add( _
  ByVal Name As BSTR, _
  ByVal Name As String, _
  ByVal Protocol As FpcProtocolMessageDefinitionTransportProtocol, _
  ByVal Protocol As FpcProtocolMessageDefinitionTransportProtocol, _
  ByRef ppDefinition As IFPCProtocolMessageDefinition _
) As FPCProtocolMessageDefinition

Parameters

  • Name

    C++

    Required. BSTR that specifies the name of the new protocol message definition to be created. The name should be unique in the collection.
    VB

    Required. String that specifies the name of the new protocol message definition to be created. The name should be unique in the collection.

  • Protocol

    C++

    Required. Value from the FpcProtocolMessageDefinitionTransportProtocol enumerated type that specifies the protocol used as a transport.
    VB

    Required. Value from the FpcProtocolMessageDefinitionTransportProtocol enumerated type that specifies the protocol used as a transport.

  • ppDefinition [out]
    Address of an interface pointer that on return points to the new IFPCProtocolMessageDefinition 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 FPCProtocolMessageDefinition 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

FPCProtocolMessageDefinitions

 

 

Build date: 7/12/2010