CRMProduct.Activate Method
The Activate method sets the state of a product to Active.
Syntax
[Visual Basic .NET]
Public Sub Activate(
ByVal Caller As CUserAuth,
ByVal ProductId As String,
ByVal Status As Integer
)
[C#]
public void Activate(
CUserAuth Caller,
string ProductId,
int Status
);
[C++]
public: void Activate(
CUserAuth* Caller,
String* ProductId,
long Status
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteProduct privilege and access rights on the object to be activated. See CUserAuth.
ProductId
Specifies the ID of the product to be activated.
Status
Specifies the status of the product. You can use this parameter to specify application status. See Remarks.
Return Value
No return value.
Remarks
Note The Status parameter corresponds to Status Reason in the Microsoft CRM application. If you pass -1 for this parameter, the platform sets the status to the appropriate value for the Microsoft CRM application. You can use the RetrieveStatus method to retrieve the status codes used in the application.
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";
// CRMProduct proxy object
Microsoft.Crm.Platform.Proxy.CRMProduct product = new Microsoft.Crm.Platform.Proxy.CRMProduct();
product.Credentials = System.Net.CredentialCache.DefaultCredentials;
product.Url = strDir + "CRMProduct.srf";
string strErrorMsg;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
string strProductId = "{9BA55E02-89B9-4257-B541-07F926E03B0B}";
// Activate the product
product.Activate(userAuth, strProductId, -1);
}
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