odm_open_class or odm_open_class_rdonly Subroutine
Purpose
Opens an ODM object class.
Library
Object Data Manager Library (libodm.a)
Syntax
#include <odmi.h>CLASS_SYMBOL ClassSymbol;
CLASS_SYMBOL odm_open_class_rdonly ( ClassSymbol)
CLASS_SYMBOL ClassSymbol;
Description
The odm_open_class subroutine can be called to open an object class. Most subroutines implicitly open a class if the class is not already open. However, an application may find it useful to perform an explicit open if, for example, several operations must be done on one object class before closing the class. The odm_open_class_rdonly subroutine opens an odm database in read-only mode.
Parameter
| Item | Description |
|---|---|
| ClassSymbol | Specifies a class symbol of the form ClassName_CLASS that is declared in the .h file created by the odmcreate command. |
Return Values
Upon successful completion, a ClassSymbol parameter for the object class is returned. If the odm_open_class or odm_open_class_rdonly 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_open_class or odm_open_class_rdonly subroutine sets the odmerrno variable to one of the following error codes:
- ODMI_CLASS_DNE
- ODMI_CLASS_PERMS
- ODMI_INVALID_PATH
- ODMI_MAGICNO_ERR
- ODMI_OPEN_ERR
- ODMI_TOOMANYCLASSES
See Object Data Manager (ODM) error codes for explanations of the ODM error codes.