editUserByRecordID
Retrieves a user record for editing based on record ID. A saveUser 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 cancelSaveUser.
To edit a user based on name, use editUser.
Changes made to global users through SOAP are also made to user records on the Helix ALM License Server.
Parameters
Parameter | Type | Description |
---|---|---|
cookie | long | Session cookie returned by projectLogon. |
recordID | long | Unique user record ID. |
Return value
Value | Type |
---|---|
pUser | CUser |
Example
CUser usr = ttsdk.editUserByRecordID(cookie, 1);
try
{
usr.middleinitials = "M";
// The following line throws an exception if the operation fails.
ttsdk.saveUser(cookie, usr.firstname, usr.middleinitials, usr.lastname, usr);
}
catch (Exception e)
{
// The following operation unlocks the record.
ttsdk.cancelSaveUser(cookie, usr.recordid);
}