CRMOpportunity.RetrieveSharedPrincipals Method

The RetrieveSharedPrincipals method retrieves all of the security principals (users or teams) that have access to an opportunity.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvReadOpportunity privilege to perform this action. See CUserAuth.

OpportunityId

Specifies the ID of the opportunity.

Rights

Specifies the rights to find. See ACCESSRIGHTS.

Return Value

Returns a CSecurityPrincipal[] type that specifies the array of security principals associated with the specified opportunity. See CSecurityPrincipal.

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 = "http://" + strServer + "/" + virtualDirectory + "/";

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

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

string strErrorMsg;
string strOpportunityId= "{3BDFF384-0E6B-42F8-924E-61A40514E6F6}";
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Retrieve the set of security principals who share this opportunity
   Microsoft.CRM.Proxy.CSecurityPrincipal[] securityPrincipals;
   securityPrincipals = opportunity.RetrieveSharedPrincipals(userAuth, strOpportunityId, Microsoft.CRM.Flags.AccessRights.CRM_ACCESS_READ);
}
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.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.