UsePresharedKey Property of the IFPCVpnNetworkL2tpPptpSettings Interface

Article
08/13/2010

The UsePresharedKey property gets or sets a Boolean value that indicates whether a preshared key is to be used for authenticating outgoing L2TP connections.

C++

HRESULT put_UsePresharedKey(
    VARIANT_BOOL fUsePresharedKey
);
HRESULT get_UsePresharedKey(
    VARIANT_BOOL* pfUsePresharedKey
);

Parameters

fUsePresharedKey
Boolean value that specifies whether a preshared key is to be used for authenticating outgoing L2TP connections.
pfUsePresharedKey
Pointer to a Boolean variable that is set on return to VARIANT_TRUE if a preshared key is to be used for authenticating outgoing L2TP connections, or to VARIANT_FALSE if a preshared key is not to be used for authenticating outgoing L2TP connections.

Return Value

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

Visual Basic

Property UsePresharedKey As Boolean

Property Value

Boolean value that indicates whether a preshared key is to be used for authenticating outgoing L2TP connections.

Remarks

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

The preshared key to be used is specified by the PresharedKey property.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.
DLL	Requires Msfpccom.dll.