CRMNotesManager.RetrieveSharedPrincipals Method
The RetrieveSharedPrincipals method retrieves all users and teams who have the specified access to the note.
Syntax
[Visual Basic .NET]
Public Function RetrieveSharedPrincipals(
ByVal Caller As CUserAuth,
ByVal NoteId As String,
ByVal Rights As UInt32
) As CSecurityPrincipal()
[C#]
public CSecurityPrincipal[] RetrieveSharedPrincipals(
CUserAuth Caller,
string NoteId,
uint Rights
);
[C++]
public: CSecurityPrincipal* RetrieveSharedPrincipals(
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
Specifies the rights for the note. See ACCESSRIGHTS.
Return Value
Returns a CSecurityPrincipal[] type that specifies an array of security 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();
// Set up the access rights
uint rights = Microsoft.CRM.Flags.AccessRights.CRM_ACCESS_READ;
// Retrieve the shared principals
Microsoft.CRM.Proxy.CSecurityPrincipal[] securityPrincipals;
securityPrincipals = notesmanager.RetrieveSharedPrincipals(userAuth, strNoteId, 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