CRMQuote.Close Method
The Close method sets the state of a quote to Closed.
Syntax
[Visual Basic .NET]
Public Sub Close(
ByVal Caller As CUserAuth,
ByVal ActivityXml As String,
ByVal PartiesXml As String,
ByVal Status As Integer
)
[C#]
public void Close(
CUserAuth Caller,
string ActivityXml,
string PartiesXml,
int Status
);
[C++]
public: void Close(
CUserAuth* Caller,
String* ActivityXml,
String* PartiesXml,
long Status
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvWriteQuote privilege to perform this action. See CUserAuth.
ActivityXml
Specifies an XML string representing an activity. The XML schema is described by activity.xsd.
PartiesXml
Specifies an XML string representing activity parties. The XML schema is described by activityparty.xsd.
Status
Specifies the status of the quote. You can use this parameter to specify application status. See Remarks.
Return Value
No return value.
Remarks
Note The Status parameter corresponds to Status Reason in the Microsoft CRM application. If you pass -1 for this parameter, the platform sets the status to the appropriate value for the Microsoft CRM application. You can use the RetrieveStatus method to retrieve the status codes used in the application.
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#]
// strServerName should be set with the name of the platform Web server
string strServerName = "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://" + strServerName + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.CRM.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMQuote proxy object
Microsoft.CRM.Proxy.CRMQuote quote = new Microsoft.CRM.Proxy.CRMQuote();
quote.Credentials = System.Net.CredentialCache.DefaultCredentials;
quote.Url = strDir + "CRMQuote.srf";
string strErrorMsg;
string strQuoteId = "{21AE236A-2A82-4064-AEEC-DD6BAF90C29E}";
string strActivity;
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for the activity
strActivity = "<activity>" +
"<objectid>" + strQuoteId + "</objectid>" +
"<objecttypecode>" + (int)Microsoft.CRM.Flags.ObjectType.otQuote.ToString() + "</objecttypecode>" +
"<owninguser>" + userAuth.UserId + "</owninguser>" +
"<activitytypecode>" + (int)Microsoft.CRM.Flags.ObjectType.otQuoteCloseActivity.ToString() + "</activitytypecode>" +
"</activity>";
// Close the quote
quote.Close(userAuth, strActivity, "", -1);
}
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.Proxy
Assembly: microsoft.crm.proxy.dll
See Also