odm_rm_by_id Subroutine
Purpose
Removes objects specified by their IDs from an ODM object class.
Library
Object Data Manager Library (libodm.a)
Syntax
#include <odmi.h>Description
The odm_rm_by_id subroutine is called to delete an object from an object class. The object to be deleted is specified by passing its object ID from its corresponding ClassName structure.
Parameters
| Item | Description |
|---|---|
| ClassSymbol | Identifies a class symbol returned from an odm_open_class subroutine. If the odm_open_class subroutine has not been called, this is the ClassName_CLASS structure that was created by the odmcreate command. |
| ObjectID | Identifies the object. This information is retrieved from the corresponding ClassName structure of the object class. |
Return Values
Upon successful completion, a value of 0 is returned. If the odm_rm_by_id 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_by_id subroutine sets the odmerrno variable to one of the following error codes:
- ODMI_CLASS_DNE
- ODMI_CLASS_PERMS
- ODMI_FORK
- ODMI_INVALID_CLXN
- ODMI_INVALID_PATH
- ODMI_MAGICNO_ERR
- ODMI_MALLOC_ERR
- ODMI_NO_OBJECT
- ODMI_OPEN_ERR
- ODMI_OPEN_PIPE
- ODMI_PARAMS
- ODMI_READ_ONLY
- ODMI_READ_PIPE
- ODMI_TOOMANYCLASSES
- ODMI_TOOMANYCLASSES
See Object Data Manager (ODM) error codes for explanations of the ODM error codes.