Share via

JoinWorkgroup Method of the IFPCServer3 Interface

  • Article

The JoinWorkgroup method joins the server to the specified workgroup using the specified user name and password to detach it from the current domain, and restarts the computer to apply the change if requested

C++

Syntax

HRESULT JoinWorkgroup(
  [in]            BSTR Workgroup,
  [in]            BSTR CurrentDomainUserName,
  [in]            BSTR CurrentDomainUserPassword,
  [in, optional]  VARIANT_BOOL RestartNow
);

Parameters

  • Workgroup
    Required. BSTR that specifies the workgroup to which the server will be joined.

  • CurrentDomainUserName
    Required. BSTR that specifies the user name in the current domain.

  • CurrentDomainUserPassword
    Required. BSTR that specifies the user password in the current domain.

  • 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 JoinWorkgroup( _
  ByVal Workgroup As String, _
  ByVal CurrentDomainUserName As String, _
  ByVal CurrentDomainUserPassword As String, _
  [ ByVal RestartNow As Boolean ] _
)

Parameters

  • Workgroup
    Required. String that specifies the workgroup to which the server will be joined.

  • CurrentDomainUserName
    Required. String that specifies the user name in the current domain.

  • CurrentDomainUserPassword
    Required. String the specifies the user password in the current domain.

  • RestartNow
    Boolean value that indicates whether to restart the computer after 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 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

FPCServer

Send comments about this topic to Microsoft

Build date: 6/30/2010