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. This XML string is in the format
<privileges> + privilege1..N + </privileges>
where the XML schema for each privilege is described by privilege.xsd.
Remarks
Unlike the Retrieve method, the XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.
The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.
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 oUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
oUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
oUser.Url = strDir + "BizUser.srf";
// SecRole proxy object
Microsoft.Crm.Platform.Proxy.BizPrivilege privilege = new Microsoft.Crm.Platform.Proxy.BizPrivilege ();
privilege.Credentials = System.Net.CredentialCache.DefaultCredentials;
privilege.Url = strDir + "BizPrivilege.srf";
// Declare the caller
Microsoft.Crm.Platform.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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also