Share via

SetDNSConfiguration Method of the IFPCVpnConfiguration Interface

  • Article

The SetDNSConfiguration method sets the primary and backup DNS servers, or specifies that the DNS server name is obtained from a DHCP server.

C++

Syntax

HRESULT SetDNSConfiguration(
  [in]            VARIANT_BOOL ObtainFromDHCP,
  [in, optional]  BSTR newPrimaryName,
  [in, optional]  BSTR newBackupName
);

Parameters

  • ObtainFromDHCP
    Boolean value that indicates whether the DNS server name is obtained from a DHCP server.

  • newPrimaryName
    String that specifies the name of the primary DNS server. The default value is an empty string.

  • newBackupName
    String value that specifies the name of the backup DNS server. The default value is an empty string.

Return Value

This method returns S_OK if the call is successful; otherwise, it returns an error code.

Visual Basic

Syntax

Sub SetDNSConfiguration( _
  ByVal ObtainFromDHCP As Boolean, _
  [ ByVal newPrimaryName As String ], _
  [ ByVal newBackupName As String ] _
)

Parameters

  • ObtainFromDHCP
    Boolean value that indicates whether the DNS server name is obtained from a DHCP server.

  • newPrimaryName
    String that specifies the name of the primary DNS server. The default value is an empty string.

  • newBackupName
    String value that specifies the name of the backup DNS server. The default value is an empty string.

Return Value

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

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.

See Also

FPCVpnConfiguration

Send comments about this topic to Microsoft

Build date: 6/30/2010