UserProfileChangeService.GetUserChanges method

Gets changes made to the specified user’s profile that match the filter conditions defined by the specified change token and the specified change query.

Namespace:  WebSvcUserProfileChangeService
Assembly:  UserProfileServices (in UserProfileServices.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://microsoft.com/webservices/SharePointPortalServer/UserProfileChangeService/GetUserChanges", RequestNamespace := "https://microsoft.com/webservices/SharePointPortalServer/UserProfileChangeService",  _
    ResponseNamespace := "https://microsoft.com/webservices/SharePointPortalServer/UserProfileChangeService",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function GetUserChanges ( _
    userAccountName As String, _
    changeToken As String, _
    changeQuery As UserProfileChangeQuery _
) As UserProfileChangeDataContainer
'Usage
Dim instance As UserProfileChangeService
Dim userAccountName As String
Dim changeToken As String
Dim changeQuery As UserProfileChangeQuery
Dim returnValue As UserProfileChangeDataContainer

returnValue = instance.GetUserChanges(userAccountName, _
    changeToken, changeQuery)
[SoapDocumentMethodAttribute("https://microsoft.com/webservices/SharePointPortalServer/UserProfileChangeService/GetUserChanges", RequestNamespace = "https://microsoft.com/webservices/SharePointPortalServer/UserProfileChangeService", 
    ResponseNamespace = "https://microsoft.com/webservices/SharePointPortalServer/UserProfileChangeService", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public UserProfileChangeDataContainer GetUserChanges(
    string userAccountName,
    string changeToken,
    UserProfileChangeQuery changeQuery
)

Parameters

  • userAccountName
    Type: System.String

    The account name of the user’s profile.

  • changeToken
    Type: System.String

    The starting location of the changes in the user profile change logs.

Return value

Type: WebSvcUserProfileChangeService.UserProfileChangeDataContainer
The changes made to the specified user’s profile that match the filter conditions defined by the specified changeToken and changeQuery.

Exceptions

Exception Condition
ArgumentException

changeQuery is not a UserProfileChangeQuery.

ChangeTokenTooEarlyException

changeToken precedes the earliest user profile change.

ArgumentNullException

userAccountName is null .

UserNotFoundException

A user profile does not exist for the user name.

Remarks

This method sets the ChangeTokenStart property of the changeQuery parameter to the value of the changeToken parameter and then returns all user profile change entries for the specified user that match the filter condition defined by the changeQuery, up to a limit of 1000.

See also

Reference

UserProfileChangeService class

UserProfileChangeService members

WebSvcUserProfileChangeService namespace