Share via

CRMInvoice.RetrievePrincipalAccess Method

  • Article

The RetrievePrincipalAccess method retrieves the access that a specified security principal has to a specific invoice.

Syntax

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

Parameters

Caller

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

InvoiceId

Specifies the ID of the invoice.

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 invoice. 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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

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

string strErrorMsg;
string strInvoiceId = "{A9920C07-EE2A-3434-A7EC-9J9D240CF535}";

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;

   // Retrieve the access for this security principal
   uint access = invoice.RetrievePrincipalAccess(userAuth, strInvoiceId, 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.