Share via

CRMLicense.RevokeUserLicense Method

  • Article

The RevokeUserLicense method revokes a software license for a user.

Syntax

[Visual Basic .NET]
Public Sub RevokeUserLicense(
  ByVal Caller As CUserAuth,
  ByVal UserId As String,
  ByVal LicenseType As String
)
[C#]
public void RevokeUserLicense(
  CUserAuth  Caller,
  string  UserId,
  string  LicenseType
);
[C++]
public: void RevokeUserLicense(
  CUserAuth*  Caller,
  String*  UserId,
  String*  LicenseType
);

Parameters

Caller

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

UserId

Specifies ID of the user.

LicenseType

Specifies the ID of the license type.

Return Value

No return value.

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

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

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

   // Now revoke user license
   license.RevokeUserLicense(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.