The am_endscan purpose function

The database server calls am_endscan when am_getnext finds no more rows.

Syntax

mi_integer am_endscan(MI_AM_SCAN_DESC *scanDesc)
scanDesc
Points to the scan descriptor.

Usage

The am_endscan purpose function might:
  • Deallocate the PER_COMMAND user-data memory that the am_beginscan purpose function allocates and stores in the scan descriptor
  • Check for transaction commit or rollback

    Call the appropriate DataBlade API functions to determine if the transaction succeeds. Disregard the copy of old values if the transaction commits or reapply old values if the transaction rolls back.

Return values

MI_OK
Indicates success.
MI_ERROR
Indicates failure.

Copyright© 2019 HCL Technologies Limited