CRMNotesManager.RetrieveSharedPrincipalsAndAccess Method

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

Syntax

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

Parameters

Caller

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

NoteId

Specifies the ID of the note.

Rights

[out]  Specifies an array of rights for the principals. See ACCESSRIGHTS.

Return Value

Returns a CSecurityPrincipal[] type that specifies an array of principals associated with the specified note. 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";

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

string strErrorMsg;
string strNoteId = "{09CBE06F-40DB-4C9D-9CAF-9B7F27294793}";
try
{

   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Create a new security principal
   Microsoft.CRM.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.CRM.Proxy.CSecurityPrincipal();
   securityPrincipal.Id = userAuth.UserId;
   securityPrincipal.Type = Microsoft.CRM.Proxy.SecurityPrincipalType.sptUser;

   // Set up the access rights
   uint[] rights;

   // Retrieve the shared principals and access
   Microsoft.CRM.Proxy.CSecurityPrincipal[] securityPrincipals;
   securityPrincipals = notesmanager.RetrieveSharedPrincipalsAndAccess(userAuth, strNoteId, 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.