SPServiceApplication.MigrateUserAccount method

Migrates user.

Namespace:  Microsoft.SharePoint.Administration
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Protected Friend Overridable Function MigrateUserAccount ( _
    subscriptionId As Guid, _
    oldPrincipalName As String, _
    newPrincipalName As String, _
    allowedOldBinaryIds As IEnumerable(Of Byte()), _
    newBinaryId As Byte() _
) As Boolean
'Usage
Dim subscriptionId As Guid
Dim oldPrincipalName As String
Dim newPrincipalName As String
Dim allowedOldBinaryIds As IEnumerable(Of Byte())
Dim newBinaryId As Byte()
Dim returnValue As Boolean

returnValue = Me.MigrateUserAccount(subscriptionId, _
    oldPrincipalName, newPrincipalName, _
    allowedOldBinaryIds, newBinaryId)

protected internal virtual bool MigrateUserAccount(
    Guid subscriptionId,
    string oldPrincipalName,
    string newPrincipalName,
    IEnumerable<byte[]> allowedOldBinaryIds,
    byte[] newBinaryId
)

Parameters

• subscriptionId
  Type: System.Guid

  Targeted subscription ID or Guid.Empty to target all subscriptions

• oldPrincipalName
  Type: System.String

  Old logon name

• newPrincipalName
  Type: System.String

  New logon name

• allowedOldBinaryIds
  Type: System.Collections.Generic.IEnumerable<[]>

  A list of valid binary IDs. Migrate only the items which binary IDs are in the list. If it is null, there is no restriction for the old binary ID.

• newBinaryId
  Type: []

  New binary ID.

Return value

Type: System.Boolean
true if service migrated user, false otherwise.

See also

Reference

SPServiceApplication class

SPServiceApplication members

Microsoft.SharePoint.Administration namespace