Share via


CRMSubject.UpdateAndRetrieve Method

The UpdateAndRetrieve method updates a subject and then retrieves it.

Syntax

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

Parameters

Caller

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

SubjectId

Specifies the ID of the subject to be updated.

SubjectXML

Specifies an XML string containing the subject information. The XML schema is described by subject.xsd.

Return Value

Returns a String type that specifies the XML data containing the requested subject. The XML schema is described by subject.xsd.

Remarks

The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.

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

   // Set up the XML string to update the subject
   string strSubjectXml = "<subject>";
   strSubjectXml += "<title>Mountain Bikes</title>";
   strSubjectXml += "<description>Mountain bike product line</description>";
   strSubjectXml += "</subject>";

   // Now update the subject
   string strResultsXml = subject.UpdateAndRetrieve (userAuth, strSubjectId, strSubjectXml);
}
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.