IFWXFilterAdmin::RegisterProtocol method

Applies to: desktop apps only

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 [in]
    GUID that will be used for uniquely identifying the protocol.

  • szProtocolName [in]
    Pointer to the name of the protocol as it is to appear in Forefront TMG Management.

  • szDescription [in]
    Pointer to the description text for the protocol.

  • ProtocolCategory [in]
    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

This method can return one of these values.

  • 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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

Forefront Threat Management Gateway (TMG) 2010

Header

Wspfwext.idl

DLL

Wspadmin.dll

See also

IFWXFilterAdmin

 

 

Build date: 7/12/2010