AuthenticationEnabled Property of the IFPCPrimaryRoute Interface

The AuthenticationEnabled property gets or sets a Boolean value that indicates whether credentials will be sent for authentication to an upstream proxy server on the primary route.

[C++]
HRESULT put_AuthenticationEnabled(
	VARIANT_BOOL fEnabled
);
HRESULT get_AuthenticationEnabled(
	VARIANT_BOOL* pfEnabled
);

Parameters

pfEnabled

Pointer to a Boolean variable that is set on return to VARIANT_TRUE if credentials will be sent for authentication to an upstream proxy server on the primary route, or to VARIANT_FALSE if no credentials will be sent for authentication to an upstream proxy server on the primary route.

fEnabled

Boolean value that specifies whether credentials will be sent for authentication to an upstream proxy server on the primary route.

Return Value

These property methods return S_OK if the call is successful; otherwise, they return an error code.

[Visual Basic]
Property AuthenticationEnabled As Boolean

Property Value

Boolean value that specifies whether credentials will be sent for authentication to an upstream proxy server on the primary route.

Remarks

This property is read/write. Its default value is False (VARIANT_FALSE in C++).

This property is applicable only if the RouteType property is set to fpcPrimaryRouteUpstream.

Authentication to an upstream proxy server should not be enabled unless valid credentials are specified in the Credentials property.

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

FPCPrimaryRoute


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.