Share via


CRMNotesManager.Update Method

The Update method updates an existing note.

Syntax

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

Parameters

Caller

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

NoteId

Specifies the ID of the note to be updated.

Note

Specifies an XML string describing the note. The XML schema is described by annotation.xsd.

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

// CRMNotesManager proxy object
Microsoft.Crm.Platform.Proxy.CRMNotesManager  notesmanager = new Microsoft.Crm.Platform.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.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   //Set up the XML string to update the note
   string strNotesManagerXml = "<annotation>";
   strNotesManagerXml += "<subject>An updated sample note</subject>";
   strNotesManagerXml += "<isdocument>0</isdocument>";
   strNotesManagerXml += "<ownerid type=\"" + Microsoft.Crm.Platform.Types.ObjectType.otSystemUser.ToString() +"\">";
   strNotesManagerXml += userAuth.UserId + "</ownerid>";
   strNotesManagerXml += "</annotation>";

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