CRMActivity.RetrievePrincipalAccess Method

The RetrievePrincipalAccess method retrieves the access a specific security principal has to a specific activity.

Syntax

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

[C#]
public uint RetrievePrincipalAccess(
  CUserAuth  Caller,
  string  ActivityId,
  CSecurityPrincipal  Principal
);

[C++]
public: unsigned long RetrievePrincipalAccess(
  CUserAuth*  Caller,
  String*  ActivityId,
  CSecurityPrincipal*  Principal
);

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.

Principal

Specifies the security principle. See CSecurityPrincipal.

Return Value

Returns a UInt32 type that specifies the access rights found for the specified principal. 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 = "http://" + 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();

   // Initialize the 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 access = activity.RetrievePrincipalAccess(userAuth, strActivityId, 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.