Share via


CRMActivity.RetrieveSharedPrincipals Method

The RetrieveSharedPrincipals method returns a list of security principals with which the activity is shared given the specified access rights.

Syntax

[Visual Basic .NET]
Public Function RetrieveSharedPrincipals(
  ByVal Caller As CUserAuth,
  ByVal ActivityId As String,
  ByVal Rights As UInt32
) As CSecurityPrincipal()

[C#]
public CSecurityPrincipal[] RetrieveSharedPrincipals(
  CUserAuth  Caller,
  string  ActivityId,
  uint  Rights
);

[C++]
public: CSecurityPrincipal* RetrieveSharedPrincipals(
  CUserAuth*  Caller,
  String*  ActivityId,
  unsigned long  Rights
)  __gc[];

Parameters

Caller

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

ActivityId

Specifies the ID of the activity.

Rights

Specifies the set of access rights the principals may have for the activity. See ACCESSRIGHTS.

Return Value

Returns a CSecurityPrincipal[] type that specifies the array of security principals found. 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";

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

string strErrorMsg;
string strActivityId = "{33A081D8-ABFF-4103-9E9B-DB0A4B1FD48E}";
try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Retrieve the shared principals
   Microsoft.Crm.Platform.Proxy.CSecurityPrincipal[] securityPrincipals = activity.RetrieveSharedPrincipals(userAuth, strActivityId, 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.