ADK Interface

Definition

The Archive Development Kit (ADK) interface is a set of function modules provided by ADK for all archiving objects.

Use

The function modules in the ADK interface are used to create, access, and process archived data and are used in:

  • Write programs
  • Delete programs
  • Read programs
  • Reload programs
  • Conversion programs

These function modules cannot be used for the actual deletion of data from the database or reloading of data into the database. Your program must handle these actions.

Structure

These function modules can be divided into:

  • Object-specific functions
    • ARCHIVE_OPEN_FOR_WRITE/DELETE/READ/MOVE
    • ARCHIVE_NEW_OBJECT, ARCHIVE_SAVE_OBJECT
    • ARCHIVE_GET_NEXT_OBJECT
    • ARCHIVE_GET_NEXT_RECORD, ARCHIVE_GET_WITH_CURSOR
    • ARCHIVE_READ_OBJECT
    • ARCHIVE_WRITE_STATISTICS
    • ARCHIVE_ROLLBACK_WORK
  • Class-specific functions
    • ARCHIVE_DELETE_OBJECT_DATA
    • ARCHIVE_REGISTER_CLASS
    • ARCHIVE_RELOAD_OBJECT_DATA
  • Common functions
    • ARCHIVE_PUT_TABLE
    • ARCHIVE_GET_TABLE
    • ARCHIVE_GET_INFORMATION
    • ARCHIVE_GIVE_STATISTICS
    • ARCHIVE_REGISTER_STRUCTURES
    • ARCHIVE_GET_INIT_DATA
    • ARCHIVE_PUT_INIT_DATA
    • ARCHIVE_GET_STRUCTURES
    • ARCHIVE_GET_INIT_STRUCTURES

Object-specific and class-specific functions can only be called by write/delete/read/reload/conversion programs, whereas the common functions can also be called by an archiving class.

See Also

  • For a graphical overview of how these function modules interact with archiving programs and archiving classes, see Archiving Class.
  • For more information about the function modules listed here, see the online function module documentation and the procedures for developing the various archiving programs.