[ Previous | Next | Contents | Glossary | Home | Search ]
AIX Version 4.3 Base Operating System and Extensions Technical Reference, Volume 1

odm_open_class Subroutine

Purpose

Opens an ODM object class.

Library

Object Data Manager Library (libodm.a)

Syntax

#include <odmi.h>
CLASS_SYMBOL odm_open_class (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.

Parameter

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 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 subroutine sets the odmerrno variable to one of the following error codes:

ODMI_CLASS_DNE
                          The specified object class does not exist. Check path name and permissions.
ODMI_CLASS_PERMS
                          The object class cannot be opened because of the file permissions.
ODMI_INVALID_PATH
                          The specified path does not exist on the file system. Make sure the path is accessible.
ODMI_MAGICNO_ERR
                          The class symbol does not identify a valid object class.
ODMI_OPEN_ERR
                          Cannot open the object class. Check path name and permissions.
ODMI_TOOMANYCLASSES
                          Too many object classes have been accessed. An application can only access less than 1024 object classes.

Implementation Specifics

This subroutine is part of Base Operating System (BOS) Runtime.

Related Information

The odm_close_class subroutine.

The odmcreate command.

List of ODM Commands and Subroutines.

See ODM Example Code and Output in AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs for an example of a .h file.

Object Data Manager (ODM) Overview for Programmers in AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs.


[ Previous | Next | Contents | Glossary | Home | Search ]