odm_terminate Subroutine

Purpose

Terminates an ODM session.

Library

Object Data Manager Library (libodm.a)

Syntax

#include <odmi.h>

int odm_terminate ( )

Description

The odm_terminate subroutine performs the cleanup necessary to terminate an ODM session. After running an odm_terminate subroutine, an application must issue an odm_initialize subroutine to resume ODM operations.

Return Values

Upon successful completion, a value of 0 is returned. If the odm_terminate subroutine is unsuccessful, a value of -1 is returned and the odmerrno variable is set to an error code.

Error Codes

Failure of the odm_terminate subroutine sets the odmerrno variable to one of the following error codes:

• ODMI_CLASS_DNE
• ODMI_CLASS_PERMS
• ODMI_INVALID_CLXN
• ODMI_INVALID_PATH
• ODMI_LOCK_ID
• ODMI_MAGICNO_ERR
• ODMI_OPEN_ERR
• ODMI_TOOMANYCLASSES
• ODMI_UNLOCK

See ../bostechref/odm_error_codes.html for explanations of the ODM error codes.