Microsoft Internet Security and Acceleration Server 2004 SDK

PresharedKey Property of IFPCVpnNetworkL2tpPptpSettings[C++]

FPCVpnNetworkL2tpPptpSettings.PresharedKey [Visual Basic]

[C++]

The PresharedKey property gets or sets the preshared key for L2TP connections.

HRESULT get_PresharedKey(
  BSTR* pbstrPresharedKey
);

HRESULT put_PresharedKey(
  BSTR bstrPresharedKey
);

Parameters

pbstrPresharedKey
Pointer to a BSTR that is set on return to a string value specifying the preshared key for L2TP connections.
bstrPresharedKey
BSTR that specifies the preshared key for 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. By default, no string is defined.

The preshared key will be used only if the UsePresharedKey property is set to VARIANT_TRUE.

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

[Visual Basic]

The PresharedKey property gets or sets the preshared key for L2TP connections.

Property PresharedKey As String

Property Value

String that specifies the preshared key for L2TP connections.

Remarks

This property is read/write. By default, no string is defined.

The preshared key will be used only if the UsePresharedKey property is set to True.

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.

Requirements

Server: Requires Windows Server 2003.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.

See Also

FPCVpnNetworkL2tpPptpSettings