Share via

CRMQuote.RetrievePrincipalAccess Method

  • Article

The RetrievePrincipalAccess method retrieves the access a security principal has to the specified quote.

Syntax

[Visual Basic .NET]
Public Function RetrievePrincipalAccess(
  ByVal Caller As CUserAuth,
  ByVal QuoteId As String,
  ByVal Principal As CSecurityPrincipal
) As UInt32
[C#]
public uint RetrievePrincipalAccess(
  CUserAuth  Caller,
  string  QuoteId,
  CSecurityPrincipal  Principal
);
[C++]
public: unsigned long RetrievePrincipalAccess(
  CUserAuth*  Caller,
  String*  QuoteId,
  CSecurityPrincipal*  Principal
);

Parameters

Caller

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

QuoteId

Specifies the ID of the quote.

Principal

Specifies the security principal for which access rights are to be retrieved. See CSecurityPrincipal.

Return Value

Returns a UInt32 type that specifies the rights the security principal has for the quote. 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#]
// strServerName should be set with the name of the platform Web server
string strServerName = "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://" + strServerName + "/" + 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";

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

string strErrorMsg;
string strQuoteId = "{21AE236A-2A82-4064-AEEC-DD6BAF90C29E}";

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

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

   // Retrieve principal access
   uint access = quote.RetrievePrincipalAccess (userAuth, strQuoteId, 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.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.