odm_rm_class Subroutine
Purpose
Removes an object class from the file system.
Library
Object Data Manager Library (libodm.a)
Syntax
#include <odmi.h>int odm_rm_class ( ClassSymbol)
CLASS_SYMBOL ClassSymbol;
CLASS_SYMBOL ClassSymbol;
Description
The odm_rm_class subroutine removes an object class from the file system. All objects in the specified class are deleted.
Parameter
| Item | Description |
|---|---|
| ClassSymbol | Identifies a class symbol returned from the odm_open_class subroutine. If the odm_open_class subroutine has not been called, this is the ClassName_CLASS structure created by the odmcreate command. |
Return Values
Upon successful completion, a value of 0 is returned. If the odm_rm_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_rm_class 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_MAGICNO_ERR
- ODMI_OPEN_ERR
- ODMI_TOOMANYCLASSES
- ODMI_UNLINKCLASS_ERR
- ODMI_UNLINKCLXN_ERR
See ../bostechref/odm_error_codes.html for explanations of the ODM error codes.