BizUser.UpdateUserSettings Method
The UpdateUserSettings method updates the user settings for the specified user.
Syntax
[Visual Basic .NET]
Public Sub UpdateUserSettings(
ByVal Caller As CUserAuth,
ByVal UserId As String,
ByVal SettingsXML As String
)
[C#]
public void UpdateUserSettings(
CUserAuth Caller,
string UserId,
string SettingsXML
);
[C++]
public: void UpdateUserSettings(
CUserAuth* Caller,
String* UserId,
String* SettingsXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvWriteUserSettings privilege to perform this action. See CUserAuth.
UserId
Specifies the ID of the user whose settings are to be updated.
SettingsXML
Specifies an XML string containing the user settings. The XML schema is described by usersettings.xsd.
Return Value
No return value.
Remarks
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.Proxy.BizUser bizUser = new Microsoft.CRM.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.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string to update the user settings
string strUserSettingsXml = "<usersettings><workplacestyle>0</workplacestyle></usersettings>";
// Update the user settings
bizUser.UpdateUserSettings(userAuth, strUserId, strUserSettingsXml);
}
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.Proxy
Assembly: microsoft.crm.proxy.dll
See Also