Share via


CRMArticleTemplate.Update Method

The Update method updates an existing article template.

Syntax

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

Parameters

Caller

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

ArticleTemplateId

Specifies the ID of the article template to update.

ArticleTemplateXML

Specifies an XML string representing the article template. The XML schema is described by kbarticletemplate.xsd.

Return Value

No return value.

Remarks

Create a value for the structure field that is meaningful for your application. Note that these article templates do not work with the Microsoft CRM application, which uses a proprietary article template format.

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

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

string strErrorMsg;
string strArticleTemplateId = "{72D46F0C-3855-4CA2-96E9-498E9BA08665}";
try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the XML string for the article template
   string strXml = "<kbarticletemplate>";
   strXml += "<structurexml>new structure</structurexml>";
   strXml += "</kbarticletemplate>";

   articletemplate.Update(userAuth, strArticleTemplateId, strXml);
}
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.