[C++]

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

HRESULT get_UsePresharedKey(
  VARIANT_BOOL* pfUsePresharedKey
);

HRESULT put_UsePresharedKey(
  VARIANT_BOOL fUsePresharedKey
);

Parameters

pfUsePresharedKey

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

fUsePresharedKey

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

Return Values

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

On computers running a Windows 2000 Server operating system, these property methods always return E_FPC_VPN_IPSEC_PRESHARED_SECRET_NOT_SUPPORTED.

Remarks

This property is read/write. Its default value is VARIANT_FALSE.

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

This property is accessible only on computers running an operating system from the Windows Server 2003 family.

[Visual Basic]

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

Property UsePresharedKey As Boolean

Property Value

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

Remarks

This property is read/write. Its default value is False.

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

This property is accessible only on computers running an operating system from the Windows Server 2003 family. An attempt to set or retrieve this property on a computer running a Windows 2000 Server operating system raises an E_FPC_VPN_IPSEC_PRESHARED_SECRET_NOT_SUPPORTED error, which can be intercepted by using an error handler.