Share via

SecRole.ChangeName Method

  • Article

The ChangeName method changes the name of an existing role.

Syntax

[Visual Basic .NET]
Public Sub ChangeName(
  ByVal Caller As CUserAuth,
  ByVal RoleId As String,
  ByVal NewName As String
)
[C#]
public void ChangeName(
  CUserAuth  Caller,
  string  RoleId,
  string  NewName
);
[C++]
public: void ChangeName(
  CUserAuth*  Caller,
  String*  RoleId,
  String*  NewName
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvWriteRole privilege and access rights on the object to be modified. See CUserAuth.

RoleId

Specifies the ID of the role whose name is to be changed. This ID is specified by the platform and is obtained at creation time or by a bulk retrieve.

NewName

Specifies the new name for the role.

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";

// strVirtualDirectory should be set with the name of the Microsoft CRM 
// virtual directory on the platform Web server
string strVirtualDirectory = "mscrmservices";

// Create the URL to the SRF files for platform objects
string strDir = "https://" + strServer + "/" + strVirtualDirectory + "/";

// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser user = new Microsoft.Crm.Platform.Proxy.BizUser ();
user.Credentials = System.Net.CredentialCache.DefaultCredentials;
user.Url = strDir + "BizUser.srf";

// SecRole proxy object
Microsoft.Crm.Platform.Proxy.SecRole secRole = new Microsoft.Crm.Platform.Proxy.SecRole ();
secRole.Credentials = System.Net.CredentialCache.DefaultCredentials;
secRole.Url = strDir + "SecRole.srf";

// Declare the caller
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = null;

string strErrorMsg;
try
{
   // Get the UserAuth of the current logged-on user
   userAuth = user.WhoAmI();

   // Retrieve the role ID by name
   string strRoleId = secRole.RetrieveIdFromName(userAuth, userAuth.MerchantId, "My Custom Role Name");
   if (strRoleId != null)
      // Change the name
      secRole.ChangeName(userAuth, strRoleId, "Another New Role Name");
}
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 + "Source: " + err.Source );
}

Requirements

Namespace: Microsoft.Crm.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.