BizUser.Update Method
The Update method updates the information about a user.
Syntax
[Visual Basic .NET]
Public Sub Update(
ByVal Caller As CUserAuth,
ByVal UserId As String,
ByVal UserXML As String
)
[C#]
public void Update(
CUserAuth Caller,
string UserId,
string UserXML
);
[C++]
public: void Update(
CUserAuth* Caller,
String* UserId,
String* UserXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteUser privilege and access rights on the object to be updated. See CUserAuth.
UserId
Specifies the ID of the user to be updated. This ID is specified by the platform and obtained at creation time.
UserXML
Specifies an XML string containing user information. The XML schema is described by systemuser.xsd.
Return Value
No return value.
Remarks
The following fields cannot be updated using the Update method: BusinessUnitId, ParentSystemUserId, and IsDisabled. Use the SetBusiness, SetParent, and Disable methods to update these fields.
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
string strErrorMsg;
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string to update the user
string strUserXml = "<systemuser><internalemailaddress>john@wintiptoys.com</internalemailaddress></systemuser>";
// Update the user information
bizUser.Update(userAuth, strUserId, strUserXml);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.Crm.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also