Share via

CRMLicense.IsLicenseValidForUser Method

  • Article

The IsLicenseValidForUser method checks whether the specified software license is valid for the user.

Syntax

[Visual Basic .NET]
Public Function IsLicenseValidForUser(
  ByVal Caller As CUserAuth,
  ByVal UserId As String,
  ByVal LicenseType As String
) As Integer
[C#]
public int IsLicenseValidForUser(
  CUserAuth  Caller,
  string  UserId,
  string  LicenseType
);
[C++]
public: long IsLicenseValidForUser(
  CUserAuth*  Caller,
  String*  UserId,
  String*  LicenseType
);

Parameters

Caller

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

UserId

Specifies the ID of the user.

LicenseType

Specifies the ID of the license type.

Return Value

Returns an Int32 type that specifies true if the software license is valid.

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";

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

string strErrorMsg = "";

// Professional Suite
string LicenseType = "{59F6D48E-F7E8-46F3-806C-3CA992D21915}"; 
int lvalid = -1;

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

   // Now check validity
   lvalid = license.IsLicenseValidForUser (userAuth, userAuth.UserId, LicenseType);

}
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.