PresharedKey Property of the IFPCVpnNetworkIPSecSettings Interface

Article
08/13/2010

The PresharedKey property gets or sets the preshared key for IPsec authentication. A preshared key is a string of text that is configured on both the VPN client and the VPN server. A preshared key provides a relatively weak authentication method. We therefore recommend that you use it only in the interim when your public key infrastructure (PKI) is being deployed to obtain computer certificates, or when a preshared key is required by VPN clients.

C++

HRESULT put_PresharedKey(
    BSTR bstrPresharedKey
);
HRESULT get_PresharedKey(
    BSTR* pbstrPresharedKey
);

Parameters

bstrPresharedKey
BSTR that specifies the preshared key for IPsec authentication.
pbstrPresharedKey
Pointer to a BSTR that is set on return to a string value specifying the preshared key for IPsec authentication.

Return Value

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

Visual Basic

Property PresharedKey As String

Property Value

String that specifies the preshared key for IPsec authentication.

Remarks

This property is read/write. Its default value is an empty string.

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.

Share via