CRMContact.RetrieveSharedPrincipals Method
The RetrieveSharedPrincipals method returns a list of security principals (users or teams) with which this contact is shared.
Syntax
[Visual Basic .NET]
Public Function RetrieveSharedPrincipals(
ByVal Caller As CUserAuth,
ByVal ContactId As String,
ByVal Rights As UInt32
) As CSecurityPrincipal()
[C#]
public CSecurityPrincipal[] RetrieveSharedPrincipals(
CUserAuth Caller,
string ContactId,
uint Rights
);
[C++]
public: CSecurityPrincipal* RetrieveSharedPrincipals(
CUserAuth* Caller,
String* ContactId,
unsigned long Rights
) __gc[];
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadContact privilege to perform this action. See CUserAuth.
ContactId
Specifies the ID of the contact.
Rights
Specifies the set of rights in which you are interested. See ACCESSRIGHTS.
Return Value
Returns a CSecurityPrincipal[] type that specifies an array of security principals (users or teams). 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";
// CRMContact proxy object
Microsoft.CRM.Proxy.CRMContact contact = new Microsoft.CRM.Proxy.CRMContact ();
contact.Credentials = System.Net.CredentialCache.DefaultCredentials;
contact.Url = strDir + "CRMContact.srf";
string strErrorMsg;
string strContactId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
uint rights = Microsoft.CRM.Flags.AccessRights.CRM_ACCESS_READ;
Microsoft.CRM.Proxy.CSecurityPrincipal[] principals ;
// Retrieve the principals that share this contact
principals = contact.RetrieveSharedPrincipals(userAuth, strContactId, 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