JoinDomain Method of the IFPCServer3 Interface

The JoinDomain method joins the server to the specified domain, and restarts the computer to apply the change if requested.

[C++]

Syntax

HRESULT JoinDomain(
  [in]			BSTR Domain,
  [in]			BSTR DomainUserName,
  [in]			BSTR DomainUserPassword,
  [in, optional]  VARIANT_BOOL RestartNow
);

Parameters

Domain

Required. BSTR that specifies the name of the domain to join.

DomainUserName

Required. BSTR that specifies domain user name.

DomainUserPassword

Required. BSTR that specifies the domain password for the user.

RestartNow

Boolean value that indicates whether to restart the computer after the method has completed.

Return Value

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

[Visual Basic]

Syntax

Sub JoinDomain( _
  ByVal Domain As String, _
  ByVal DomainUserName As String, _
  ByVal DomainUserPassword As String, _
  [ ByVal RestartNow As Boolean ] _
)

Parameters

Domain

Required. String that specifies the name of the domain to join.

DomainUserName

Required. String that specifies the domain user name.

DomainUserPassword

Required. String that specifies the domain password for the user.

RestartNow

Boolean value that indicates whether to restart the computer after the the method has completed.

Return Value

If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Remarks

The computer must be restarted to apply the change.

Requirements

Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.
DLL

Requires Msfpccom.dll.

See Also

FPCServer


Send comments about this topic to Microsoft

Build date: 11/30/2009

 

© 2008 Microsoft Corporation. All rights reserved.