Share via


SecRole.RetrieveIdFromName Method

The RetrieveIdFromName method retrieves the ID for the role with a specified name in a specified business unit.

Syntax

[Visual Basic .NET]
Public Function RetrieveIdFromName(
  ByVal Caller As CUserAuth,
  ByVal BusinessId As String,
  ByVal RoleName As String
) As String
[C#]
public string RetrieveIdFromName(
  CUserAuth  Caller,
  string  BusinessId,
  string  RoleName
);
[C++]
public: String* RetrieveIdFromName(
  CUserAuth*  Caller,
  String*  BusinessId,
  String*  RoleName
);

Parameters

Caller

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

BusinessId

Specifies the ID of the business unit to which the role belongs. This ID is specified by the platform and is obtained at business unit creation time or by a bulk retrieve.

RoleName

Specifies the name of the role to be retrieved.

Return Value

Returns a String type that specifies the ID of the specified role.

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, "Custom Security Role");
}
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.