BizPrivilege.RetrievePrivilegeSet Method

The RetrievePrivilegeSet method retrieves all the privileges defined in the deployment.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. See CUserAuth.

Return Value

Returns a String type that specifies the XML data containing the set of privileges retrieved. The XML schema is described by privilege.xsd.

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.Proxy.BizUser oUser   = new Microsoft.CRM.Proxy.BizUser ();
oUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
oUser.Url = strDir + "BizUser.srf";

// SecRole proxy object
Microsoft.CRM.Proxy.BizPrivilege privilege   = new Microsoft.CRM.Proxy.BizPrivilege ();
privilege.Credentials = System.Net.CredentialCache.DefaultCredentials;
privilege.Url = strDir + "BizPrivilege.srf";

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

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

   // Retrieve all the privileges
   strPrivilegeSet = privilege.RetrievePrivilegeSet(userAuth);
}
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.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.