CRMEmailTemplate.RetrievePrincipalAccess Method
The RetrievePrincipalAccess method retrieves the access rights that a security principal has for an e-mail template.
Syntax
[Visual Basic .NET]
Public Function RetrievePrincipalAccess(
ByVal Caller As CUserAuth,
ByVal TemplateId As String,
ByVal Principal As CSecurityPrincipal
) As UInt32
[C#]
public uint RetrievePrincipalAccess(
CUserAuth Caller,
string TemplateId,
CSecurityPrincipal Principal
);
[C++]
public: unsigned long RetrievePrincipalAccess(
CUserAuth* Caller,
String* TemplateId,
CSecurityPrincipal* Principal
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadEmailTemplate privilege and access rights on the object to be retrieved. See CUserAuth.
TemplateId
Specifies the ID of the e-mail template.
Principal
Specifies the security principal for whom access rights are to be retrieved. See CSecurityPrincipal.
Return Value
Returns a UInt32 type that specifies the rights the security principal is assigned for the e-mail template. 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 = "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";
// CRMEmailTemplate proxy object
Microsoft.Crm.Platform.Proxy.CRMEmailTemplate emailtemplate = new Microsoft.Crm.Platform.Proxy.CRMEmailTemplate();
emailtemplate.Credentials = System.Net.CredentialCache.DefaultCredentials;
emailtemplate.Url = strDir + "CRMEmailTemplate.srf";
string strErrorMsg;
string strEmailTemplateId = "{586D80AA-3E9B-4936-ABCA-2C4EB37FBE82}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Create a new 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;
// Now retrieve principal access
uint access = emailtemplate.RetrievePrincipalAccess(userAuth, strEmailTemplateId, 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