Typical C Outline API Task Sequence

This is a typical order of operations for a simple Outline API application.

  1. Create and initialize an ESX_INIT_T structure.

  2. Initialize the Outline API by calling EsxInit().

  3. Allocate any local static or global structures.

  4. Log on to the required server by calling EsxLogin() or EsxAutoLogin().

  5. Create and initialize an ESX_OUTLINEINFO_T structure (only for a new outline).

  6. Open an existing outline or create a new outline by calling EsxOtlOpenOutline() or EsxOtlNewOutline().

  7. Work on the outline.

  8. Verify the outline by calling EsxOtlVerifyOutline().

  9. Write the verified outline to the server by calling EsxOtlWriteOutline().

    The outline is saved with an .OTN extension.

  10. Restructure the database by calling EsxOtlRestructure().

    The .OTN file is changed to an .OTL file. This is an asynchronous function call; therefore, you should call EsxGetProcessState() until the process is complete.

  11. Unlock the outline (if it was locked on opening) by calling EsxUnlockObject().

  12. Free all information associated with the outline by calling EsxOtlCloseOutline().

  13. Log off the server by calling EsxLogout().

  14. Free any local static or global structures.

  15. Terminate the API by calling EsxTerm().