Share via


CRMAccount.RetrieveSharedPrincipals Method

The RetrieveSharedPrincipals method returns a list of security principals with whom this account is shared.

Syntax

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

Parameters

Caller

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

AccountId

Specifies the ID of the account.

Rights

Specifies the set of rights in which you are interested. See ACCESSRIGHTS.

Return Value

Returns a CSecurityPrincipal[] type that specifies the array of security principals requested. 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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.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 strAccountId = "{3E24E79C-7EC5-4473-95FF-7E46FEBB534B}";

try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Initialize security principal
   Microsoft.Crm.Platform.Proxy.CSecurityPrincipal[] securityPrincipals;

   // Retrieve shared principal access
   securityPrincipals = account.RetrieveSharedPrincipals(userAuth, strAccountId, Microsoft.Crm.Platform.Types.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.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.