CRMNewsArticle.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates a news article and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal ArticleId As String,
ByVal InArticleXML As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string ArticleId,
string InArticleXML
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* ArticleId,
String* InArticleXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteNewsArticle and prvReadNewsArticle privileges and access rights on the object to be updated. See CUserAuth.
ArticleId
Specifies the ID of the news article to be updated.
InArticleXML
Specifies an XML string representing a news article. The XML schema is described by businessunitnewsarticle.xsd.
Return Value
Returns a String type that specifies the XML data representing the updated news article. The XML schema is described by businessunitnewsarticle.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";
// CRMNewsArticle proxy object
Microsoft.Crm.Platform.Proxy.CRMNewsArticle newsarticle = new Microsoft.Crm.Platform.Proxy.CRMNewsArticle();
newsarticle.Credentials = System.Net.CredentialCache.DefaultCredentials;
newsarticle.Url = strDir + "CRMNewsarticle.srf";
string strErrorMsg;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
string strNewsArticleId = "{FLF931CA-C345-68K8-BB80-CA1BD47BFD8F}";
// Set up the XML string for the news article
string xml = "<businessunitnewsarticle>";
xml += "<newsarticle>Free Bicycle Training Workshop</newsarticle>";
xml += "</businessunitnewsarticle>";
// Update and retrieve the news article
string strResultsXml = newsarticle.UpdateAndRetrieve(userAuth, strNewsArticleId, xml);
}
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