Share via

CRMArticle.UnPublish Method

  • Article

The UnPublish method sets the state of an article to Waiting for Approval.

Syntax

[Visual Basic .NET]
Public Sub UnPublish(
  ByVal Caller As CUserAuth,
  ByVal ArticleId As String
)

[C#]
public void UnPublish(
  CUserAuth  Caller,
  string  ArticleId
);

[C++]
public: void UnPublish(
  CUserAuth*  Caller,
  String*  ArticleId
);

Parameters

Caller

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

ArticleId

Specifies the ID of the article to remove from the set of published articles.

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

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

string strErrorMsg;
try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   string strArticleId = "{70769894-638F-41F2-A692-E2BC7ED23557}";

   // Unpublish the article
   article.UnPublish(userAuth, strArticleId);
}
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.