Share via

CRMContact.Deactivate Method

  • Article

The Deactivate method sets the state of a contact to Inactive.

Syntax

[Visual Basic .NET]
Public Sub Deactivate(
  ByVal Caller As CUserAuth,
  ByVal ContactId As String,
  ByVal Status As Integer
)
[C#]
public void Deactivate(
  CUserAuth  Caller,
  string  ContactId,
  int  Status
);
[C++]
public: void Deactivate(
  CUserAuth*  Caller,
  String*  ContactId,
  long  Status
);

Parameters

Caller

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

ContactId

Specifies the ID of the contact to deactivate.

Status

Specifies the status of the contact. 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";

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

string strErrorMsg;
string strContactId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Deactivate this contact
   contact.Deactivate(userAuth, strContactId, -1);

   // Activate this contact
   contact.Activate(userAuth, strContactId, -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

© 2005 Microsoft Corporation. All rights reserved.