CRMContract.Hold Method
The Hold method sets the state of a contract to Hold.
Syntax
[Visual Basic .NET]
Public Sub Hold(
ByVal Caller As CUserAuth,
ByVal ContractId As String,
ByVal Status As Integer
)
[C#]
public void Hold(
CUserAuth Caller,
string ContractId,
int Status
);
[C++]
public: void Hold(
CUserAuth* Caller,
String* ContractId,
long Status
);
Parameters
Caller
Specifies the identity of the caller. See CUserAuth.
ContractId
Specifies the ID of the contract to be placed on hold.
Status
Specifies the state of the contract. You can use this for 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 that are 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#]
// 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";
// CRMContract proxy object
Microsoft.Crm.Platform.Proxy.CRMContract contract = new Microsoft.Crm.Platform.Proxy.CRMContract ();
contract.Credentials = System.Net.CredentialCache.DefaultCredentials;
contract.Url = strDir + "CRMContract.srf";
string strErrorMsg;
string strContractId = "{A87D821C-DF25-4FA0-A4F6-E2F41AB2B336}";
string date = DateTime.Now.AddDays(5).ToString("s");
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Invoice the contract
contract.Invoice(userAuth, strContractId, -1);
// Hold the contract
contract.Hold(userAuth, strContractId, -1);
// Release the hold on the contract
contract.ReleaseHold(userAuth, strContractId, -1);
// Cancel the contract
contract.Cancel(userAuth, strContractId, date, -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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also