editFolderByRecordID
Retrieves a folder record for editing based on record ID. 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 path, use editFolder.
Parameters
| Parameter | Type | Description |
|---|---|---|
| cookie | long | Session cookie returned by projectLogon. |
| recordID | long | Unique folder record ID. |
| publicFolder | boolean | Indicates if the folder is public or private. |
Return value
| Value | Type |
|---|---|
| pFolder | CFolder |
Example
CFolder folder = ttsdk.editFolderByRecordID(cookie, 1, true);
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);
}