CRMNotesManager.Delete Method

The Delete method deletes the specified note.

Syntax

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

Parameters

Caller

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

NoteId

Specifies the ID of the note that is to be deleted. This ID is determined by the platform and is obtained either at the time the note is created or through a bulk retrieve.

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

// CRMNotesManager proxy object
Microsoft.CRM.Proxy.CRMNotesManager  notesmanager = new Microsoft.CRM.Proxy.CRMNotesManager();
notesmanager.Credentials = System.Net.CredentialCache.DefaultCredentials;
notesmanager.Url = strDir + "CRMNotesManager.srf";

string strErrorMsg;
string strNoteId = "{09CBE06F-40DB-4C9D-9CAF-9B7F27294793}";
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Delete the note
   notesmanager.Delete(userAuth, strNoteId);
}
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.