Share via

SecRole.Delete Method

  • Article

The Delete method deletes a role.

Syntax

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

Parameters

Caller

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

RoleId

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

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 strSecRoleXML = "";
string strRoleId = "";
string strErrorMsg = "";

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

   // Set up the XML string for the role in the business unit of the caller
   strSecRoleXML = "<role>" + 
      "<name>Custom Security Role</name>" + 
      "<businessunitid>" + userAuth.MerchantId + "</businessunitid>" +
      "</role>";

   // The method returns the ID of the newly created role
   strRoleId = secRole.Create(userAuth, strSecRoleXML);

   // Now delete the new role
   secRole.Delete(userAuth, strRoleId);
}
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.