Share via


Add Method of the IFPCProtocolMessageDefinitions Interface

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

C++

Syntax

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

Parameters

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

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

  • ppDefinition
    Address of an interface pointer that on return points to the new IFPCProtocolMessageDefinition 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 Protocol As FpcProtocolMessageDefinitionTransportProtocol _
) As FPCProtocolMessageDefinition

Parameters

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

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

Return Value

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

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

FPCProtocolMessageDefinitions

Send comments about this topic to Microsoft

Build date: 6/30/2010