cancelSaveRequirementDocument

Unlocks a requirement document record locked by editRequirementDocument or editRequirementDocumentByRecordID. Does not need to be called if saveRequirementDocument is successful. A SOAP error envelope is returned if the operation fails.

Parameters

Parameter Type Description
cookie long Session cookie returned by projectLogon.
recordID long Unique requirement document record ID.

Return value

Value Type Notes
result int 0 indicates success. Check the return value in case of an error.

Example

CRequirementDocument reqDoc = ttsdk.editRequirementDocument(cookie, 0, "Requirement document name", false);

 

try

{

reqDoc.name = "";

 

// The following line throws an exception if name is a required field.

ttsdk.saveRequirementDocument(cookie, reqDoc);

}

catch (Exception e)

{

ttsdk.cancelSaveRequirementDocument(cookie, reqDoc.recordid);

}