Share via


CRMOpportunity.RetrievePrincipalAccess Method

The RetrievePrincipalAccess method retrieves the access a specific security principal has for a specific opportunity.

Syntax

[Visual Basic .NET]
Public Function RetrievePrincipalAccess(
  ByVal Caller As CUserAuth,
  ByVal OpportunityId As String,
  ByVal Principal As CSecurityPrincipal
) As UInt32
[C#]
public uint RetrievePrincipalAccess(
  CUserAuth  Caller,
  string  OpportunityId,
  CSecurityPrincipal  Principal
);
[C++]
public: unsigned long RetrievePrincipalAccess(
  CUserAuth*  Caller,
  String*  OpportunityId,
  CSecurityPrincipal*  Principal
);

Parameters

Caller

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

OpportunityId

Specifies the ID of the opportunity.

Principal

Specifies security principal (user or team). See CSecurityPrincipal.

Return Value

Returns a UInt32 type that specifies the rights the principal has for the opportunity. 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";

// CRMOpportunity proxy object
Microsoft.Crm.Platform.Proxy.CRMOpportunity opportunity = new Microsoft.Crm.Platform.Proxy.CRMOpportunity();
opportunity.Credentials = System.Net.CredentialCache.DefaultCredentials;
opportunity.Url = strDir + "CRMOpportunity.srf";

// CRMAccount proxy object
Microsoft.Crm.Platform.Proxy.CRMAccount account = new Microsoft.Crm.Platform.Proxy.CRMAccount ();
account.Credentials = System.Net.CredentialCache.DefaultCredentials;
account.Url = strDir + "CRMAccount.srf";

string strErrorMsg;
string strOpportunityId= "{3BDFF384-0E6B-42F8-924E-61A40514E6F6}";
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 the security principal
   uint uintAccessVal = opportunity.RetrievePrincipalAccess(userAuth, strOpportunityId, 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

© 2005 Microsoft Corporation. All rights reserved.