CRMOpportunity.ValidForClose Method
The ValidForClose method checks whether this opportunity is valid for close.
Syntax
[Visual Basic .NET]
Public Function ValidForClose(
ByVal Caller As CUserAuth,
ByVal OpportunityId As String,
ByRef OpenQuoteCount As Integer
) As Integer
[C#]
public int ValidForClose(
CUserAuth Caller,
string OpportunityId,
out int OpenQuoteCount
);
[C++]
public: long ValidForClose(
CUserAuth* Caller,
String* OpportunityId,
long* OpenQuoteCount
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadOpportunity privilege and access rights on the object. See CUserAuth.
OpportunityId
Specifies the ID of the opportunity.
OpenQuoteCount
[out] Specifies the number of draft or active quotes for this opportunity.
Return Value
Returns an Int32 type that specifies true if the opportunity can be closed.
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";
// CRMOpportunity proxy object
Microsoft.Crm.Platform.Proxy.CRMOpportunity opportunity = new Microsoft.Crm.Platform.Proxy.CRMOpportunity();
opportunity.Credentials = System.Net.CredentialCache.DefaultCredentials;
opportunity.Url = strDir + "CRMOpportunity.srf";
string strErrorMsg;
string strOpportunityId= "{3BDFF384-0E6B-42F8-924E-61A40514E6F6}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
int qcount;
// Check whether the opportunity is valid for close
int valid = opportunity.ValidForClose(userAuth, strOpportunityId, out qcount);
}
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