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. Protocol message definition name or one-based index of the FPCProtocolMessageDefinitionParameter object to remove.

Value

BSTR specifying the definition 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. Protocol message definition name or one-based index of the FPCProtocolMessageDefinitionParameter object to remove.

Value

String value specifying the definition parameter. The default value is an empty string (NULL).

Return Value

If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Requirements

Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

DLL

Requires Msfpccom.dll.

See Also

FPCProtocolMessageDefinition


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.