Share via


Remove Method of the IFPCProtocolMessageDefinition Interface

The Remove method removes the specified FPCProtocolMessageDefinitionParameter object from the collection.

C++

Syntax

HRESULT Remove(
  [in]            VARIANT IndexOrName,
  [in, optional]  BSTR Value
);

Parameters

  • IndexOrName
    Required. Parameter name or one-based index of the FPCProtocolMessageDefinitionParameter object to remove.

  • Value
    Optional. BSTR specifying the value of the protocol message parameter. The default value is an empty string (NULL).

Return Value

This method returns S_OK if the call is successful; otherwise, it returns an error code.

Visual Basic

Syntax

Sub Remove( _
  ByVal IndexOrName As Variant, _
  [ ByVal Value As String ] _
)

Parameters

  • IndexOrName
    Required. Parameter name or one-based index of the FPCProtocolMessageDefinitionParameter object to remove.

  • Value
    Optional. String value specifying the value of the protocol message parameter. The default value is an empty string (NULL).

Return Value

This method has no return values. If the call is unsuccessful, 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

FPCProtocolMessageDefinition

Send comments about this topic to Microsoft

Build date: 6/30/2010