IFPCProtocolMessageDefinition::Remove method

Applies to: desktop apps only

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

Syntax

HRESULT Remove(
  [in]            VARIANT IndexOrName,
  [in]            Variant IndexOrName,
  [in, optional]  BSTR Value,
  [in, optional]  String Value
);
FPCProtocolMessageDefinition.Remove( _
  ByVal IndexOrName As VARIANT, _
  ByVal IndexOrName As Variant, _
  [ ByVal Value As BSTR ], _
  [ ByVal Value As String ] _
)

Parameters

  • IndexOrName [in]

    C++

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

    VB

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

  • Value [in, optional]

    C++

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

    VB

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

Return value

C++

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

VB

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

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

FPCProtocolMessageDefinition

 

 

Build date: 7/12/2010