editFolder
Retrieves a folder record for editing based on path. A saveFolder operation must be used with this operation to save any changes to the record. A SOAP error envelope is returned if the operation fails.
To unlock the record without saving changes, use cancelSaveFolder.
To edit a folder based on record ID, use editFolderByRecordID.
You cannot change the order of folders in the hierarchy using the Helix ALM SDK.
Parameters
| Parameter | Type | Description |
|---|---|---|
| cookie | long | Session cookie returned by projectLogon. |
| folderPath | string | Full path to the folder. Do not include a trailing slash (e.g. /Public/folder A/folder a). |
Return value
| Value | Type |
|---|---|
| pFolder | CFolder |
Example
CFolder folder = ttsdk.editFolder(cookie, "/Public/test folder 1");
try
{
folder.name = "test folder 1 SOAP EDIT";
// The following line throws an exception if the operation fails.
ttsdk.saveFolder(cookie, folder);
}
catch (Exception e)
{
// The following operation unlocks the record.
ttsdk.cancelSaveFolder(cookie, folder.recordid);
}