Share via

CRMContact.Delete Method

  • Article

The Delete method deletes a contact. When Delete is called on a contact, all child objects of the contact are also deleted. If the caller does not have the DELETE privilege for any of these child objects, then the entire deletion fails.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvDeleteContact privilege to perform this action. See CUserAuth.

ContactId

Specifies the ID of the contact to delete.

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

// CRMContact proxy object
Microsoft.CRM.Proxy.CRMContact contact = new Microsoft.CRM.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.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Delete the contact
   contact.Delete(userAuth, strContactId);
}
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.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.