RegisterProtocol Method of the IFWXFilterAdmin Interface

The RegisterProtocol method registers a protocol. A registered protocol will appear in Forefront TMG Management.

Syntax

HRESULT RegisterProtocol(
  [in]  REFGUID guidProtocol,
  [in]  LPCSTR szProtocolName,
  [in]  LPCSTR szDescription,
  [in]  long ProtocolCategory,
		LPCSTR Reserved
);

Parameters

guidProtocol

GUID that will be used for uniquely identifying the protocol.

szProtocolName

Pointer to the name of the protocol as it is to appear in Forefront TMG Management.

szDescription

Pointer to the description text for the protocol.

ProtocolCategory

A 32-bit integer that specifies the category of the protocol. This can be a bitwise combination of values from the FpcProtocolCategory enumerated type.

Reserved

Reserved for future use. The Reserved parameter passes a null string.

Return Value

S_OK

The protocol was registered successfully.

HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS)

The protocol is already defined.

Error code

The protocol registration failed.

Requirements

Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
Header

Declared in Wspfwext.idl.

DLL

Requires Wspadmin.dll.

See Also

IFWXFilterAdmin


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.