CRMContract.Clone Method
The Clone method creates a copy of an existing contract and its line items.
Syntax
[Visual Basic .NET]
Public Function Clone(
ByVal Caller As CUserAuth,
ByVal ContractId As String,
ByVal IncludeCanceledLines As Integer
) As String
[C#]
public string Clone(
CUserAuth Caller,
string ContractId,
int IncludeCanceledLines
);
[C++]
public: String* Clone(
CUserAuth* Caller,
String* ContractId,
long IncludeCanceledLines
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvCreateContract privilege to perform this action. See CUserAuth.
ContractId
Specifies the ID of the contract that is to be copied.
IncludeCanceledLines
Specifies a flag to indicate whether the canceled line items of the original contract are to be included in the copy (clone).
Return Value
Returns a String type that specifies the XML data containing the new contract information. The XML schema is described by contract.xsd.
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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMContract proxy object
Microsoft.CRM.Proxy.CRMContract contract = new Microsoft.CRM.Proxy.CRMContract ();
contract.Credentials = System.Net.CredentialCache.DefaultCredentials;
contract.Url = strDir + "CRMContract.srf";
string strErrorMsg;
string strContractId = "{A87D821C-DF25-4FA0-A4F6-E2F41AB2B336}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Copy the contract
string strNewContractXml = contract.Clone(userAuth, strContractId, 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