Share via


SecRole.Retrieve Method

The Retrieve method retrieves a role.

Syntax

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

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.

RoleId

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

ColumnSetXml

Specifies an XML string used to define the columns that are to be returned. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). You can find the valid column names in role.xsd. See also ColumnSetXML Schema.

Return Value

Returns a String type that specifies the XML data describing the returned role. The XML schema is described by role.xsd.

Remarks

This method always returns a single object; therefore, ignoring any filter criteria specified in the ColumnSetXml parameter.

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

   // Specify the columns that you want to retrieve
   string strColumnSetXml = "<columnset>";
   strColumnSetXml += "<column>name</column>";
   strColumnSetXml += "<column>roleid</column>";
   strColumnSetXml += "<column>businessunitid</column>";
   strColumnSetXml += "</columnset>";
   
   string strResultsXml = secRole.Retrieve(userAuth, strRoleId, strColumnSetXml);

}
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.