CRMQueue.Create Method

The Create method creates a public queue.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvCreateQueue privilege. See CUserAuth.

QueueXML

Specifies an XML string representing the queue. The XML schema is described by queue.xsd.

Return Value

Returns a String type that specifies the ID of the newly created queue.

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

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

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

   // Set up the XML string for the queue
   string strQueueXml = "<queue>";
   strQueueXml += "<businessunitid>" + userAuth.MerchantId + "</businessunitid>";
   strQueueXml += "<primaryuserid>" + userAuth.UserId + "</primaryuserid>";
   strQueueXml += "</queue>";

   // Create the queue
   string strQueueid = queue.Create(userAuth, strQueueXml);
}
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.