Difference between revisions of "CATable::Update"
(Marked this version for translation) |
|||
| Line 3: | Line 3: | ||
<languages /> | <languages /> | ||
<translate> | <translate> | ||
| − | = [[CATable]]::Update() = | + | = [[CATable]]::Update() = <!--T:1--> |
| + | <!--T:2--> | ||
'''For ''definition'' tables:''' Updates an existing input table in the definition attribute of an Analytica object. Use this method after setting one or more cells using [[CATable::SetDataByElement|SetDataByElement]] or [[CATable::SetDataByElement|SetDataByLabel]]. '''Update''' directs the API to set the new table data to the Analytica Decision Engine Server. | '''For ''definition'' tables:''' Updates an existing input table in the definition attribute of an Analytica object. Use this method after setting one or more cells using [[CATable::SetDataByElement|SetDataByElement]] or [[CATable::SetDataByElement|SetDataByLabel]]. '''Update''' directs the API to set the new table data to the Analytica Decision Engine Server. | ||
| + | <!--T:3--> | ||
When the source table is a [[SubTable]] or [[MultiTable]], it also refreshes the table data in case one of the sources changed after the previous call to [[CAObject::DefTable]] or [[CATable::Update]]. | When the source table is a [[SubTable]] or [[MultiTable]], it also refreshes the table data in case one of the sources changed after the previous call to [[CAObject::DefTable]] or [[CATable::Update]]. | ||
| + | <!--T:4--> | ||
'''For ''result'' tables:''' Retrieves an updated version of the result table from the Analytica Decision Engine Server. | '''For ''result'' tables:''' Retrieves an updated version of the result table from the Analytica Decision Engine Server. | ||
| − | = Return Value = | + | = Return Value = <!--T:5--> |
| + | <!--T:6--> | ||
Boolean, true for success, false for failure. | Boolean, true for success, false for failure. | ||
| + | <!--T:7--> | ||
On failure, check [[CAEngine::ErrorCode]], [[CAEngine::ErrorText]] and [[CAEngine::OutputBuffer]] for information on the cause of the failure. | On failure, check [[CAEngine::ErrorCode]], [[CAEngine::ErrorText]] and [[CAEngine::OutputBuffer]] for information on the cause of the failure. | ||
| − | = Remarks = | + | = Remarks = <!--T:8--> |
| + | <!--T:9--> | ||
Use with the [[CAObject::CreateDefTable]] method to replace the current definition attribute of an Analytica object with an input table. | Use with the [[CAObject::CreateDefTable]] method to replace the current definition attribute of an Analytica object with an input table. | ||
| − | = See Also = | + | = See Also = <!--T:10--> |
| + | <!--T:11--> | ||
* [[CATable]] | * [[CATable]] | ||
* [[CAObject::DefTable]] | * [[CAObject::DefTable]] | ||
Revision as of 01:15, 16 June 2015
ADE User Guide > ADE Server Class Reference > CATable
CATable::Update()
For definition tables: Updates an existing input table in the definition attribute of an Analytica object. Use this method after setting one or more cells using SetDataByElement or SetDataByLabel. Update directs the API to set the new table data to the Analytica Decision Engine Server.
When the source table is a SubTable or MultiTable, it also refreshes the table data in case one of the sources changed after the previous call to CAObject::DefTable or CATable::Update.
For result tables: Retrieves an updated version of the result table from the Analytica Decision Engine Server.
Return Value
Boolean, true for success, false for failure.
On failure, check CAEngine::ErrorCode, CAEngine::ErrorText and CAEngine::OutputBuffer for information on the cause of the failure.
Remarks
Use with the CAObject::CreateDefTable method to replace the current definition attribute of an Analytica object with an input table.
Enable comment auto-refresher