Share via


CRMSalesOrder.RetrievePrincipalAccess Method

The RetrievePrincipalccess method retrieves the access a security principal has to the specified sales order.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvReadOrder privilege and access rights on the object to be retrieved. See CUserAuth.

SalesOrderId

Specifies the ID of the sales order for which access is to be retrieved.

Principal

Specifies the security principal (user or team) for whom access is to be retrieved. See CSecurityPrincipal.

Return Value

Returns a UInt32 type that specifies the rights the security principal has for the sales order.

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

// CRMSalesOrder proxy object
Microsoft.Crm.Platform.Proxy.CRMSalesOrder salesorder = new Microsoft.Crm.Platform.Proxy.CRMSalesOrder ();
salesorder.Credentials = System.Net.CredentialCache.DefaultCredentials;
salesorder.Url = strDir + "CRMSalesOrder.srf";

string strErrorMsg;
string strSalesOrderId = "{37F05EC6-0A39-400E-84D1-CCD9F72F034F}";

try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
   
   // Intialize the 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;

   // Retrieve the access
   uint access = salesorder.RetrievePrincipalAccess (userAuth, strSalesOrderId, 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

© 2005 Microsoft Corporation. All rights reserved.