Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

[docs] dev - improve annotation for db_update_i64 #9951

Merged
merged 2 commits into from
Jan 22, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,13 @@ namespace webassembly {
* @param itr - iterator to the table row containing the record to update.
* @param payer - the account that pays for the storage costs.
* @param buffer - new updated record.
*
*
* @remark This function does not allow changing the primary key of a
* table row. The serialized data that is stored in the table row of a
* primary table may include a primary key and that primary key value
* could be changed by the contract calling the db_update_i64 intrinsic;
* but that does not change the actual primary key of the table row.
*
* @pre `itr` points to an existing table row in the table.
* @post the record contained in the table row pointed to by `itr` is replaced with the new updated record.
*/
Expand Down