CRMContract.RetrieveSharedPrincipalsAndAccess Method

  • Article

The RetrieveSharedPrincipalsAndAccess method retrieves all of the security principals (users and teams) that have access to a contract and their access rights for that contract.

Syntax

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

Parameters

Caller

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

ContractId

Specifies the ID of the contract.

Rights

Specifies the set of rights for the security principals. See ACCESSRIGHTS.

Return Value

Returns a CSecurityPrincipal[] type that specifies the array of security principals associated with the specified contract. 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 = "https://" + 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";

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

string strErrorMsg;
string strContractId = "{A87D821C-DF25-4FA0-A4F6-E2F41AB2B336}";
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   Microsoft.CRM.Proxy.CSecurityPrincipal[] securityPrincipals;
   uint[] rights;

   securityPrincipals = contract.RetrieveSharedPrincipalsAndAccess(userAuth, strContractId, out rights);
}
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.