CRMLead.RetrievePrincipalAccess Method
The RetrievePrincipalAccess method retrieves the access the security principal has for the specified lead.
Syntax
[Visual Basic .NET]
Public Function RetrievePrincipalAccess(
ByVal Caller As CUserAuth,
ByVal LeadId As String,
ByVal Principal As CSecurityPrincipal
) As UInt32
[C#]
public uint RetrievePrincipalAccess(
CUserAuth Caller,
string LeadId,
CSecurityPrincipal Principal
);
[C++]
public: unsigned long RetrievePrincipalAccess(
CUserAuth* Caller,
String* LeadId,
CSecurityPrincipal* Principal
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadLead privilege and access rights on the object to be retrieved. See CUserAuth.
LeadId
Specifies the ID of the lead.
Principal
Specifies the security principle. See CSecurityPrincipal.
Return Value
Returns a UInt32 type that specifies the rights the principal has for the lead. See ACCESSRIGHTS.
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";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMLead proxy object
Microsoft.Crm.Platform.Proxy.CRMLead lead = new Microsoft.Crm.Platform.Proxy.CRMLead ();
lead.Credentials = System.Net.CredentialCache.DefaultCredentials;
lead.Url = strDir + "CRMLead.srf";
string strErrorMsg;
string strLeadId = "{0876468B-8FC4-4381-8D81-C0B4D05E9386}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Create a new security principal
Microsoft.Crm.Platform.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.Crm.Platform.Proxy.CSecurityPrincipal();
securityPrincipal.Id = userAuth.UserId;
securityPrincipal.Type = Microsoft.Crm.Platform.Proxy.SecurityPrincipalType.sptUser;
// Retrieve the access rights for this principal
uint access = lead.RetrievePrincipalAccess(userAuth, strLeadId, securityPrincipal);
}
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 );
}
Requirements
Namespace: Microsoft.Crm.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also