Share via

CRMSubject.Delete Method

  • Article

The Delete method deletes a subject and then re-links all child subjects. If the subject has a child object, such as a knowledge base article that references it, the delete operation fails.

Syntax

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

Parameters

Caller

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

SubjectId

Specifies the ID of the subject to be deleted.

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

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

string strErrorMsg;

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

   string strSubjectId = "{E4735CBC-A539-4B8C-B848-0C3C94E19BA6}";

   // Delete the subject
   subject.Delete (userAuth, strSubjectId);
}
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.