Technical Reference: Base Operating System and Extensions, Volume 1

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>

int odm_rm_by_id( ClassSymbol, ObjectID) CLASS_SYMBOL ClassSymbol; int ObjectID;

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

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:

See Appendix B, ODM Error Codes in AIX 5L Version 5.1 Technical Reference: Base Operating System and Extensions Volume 1 for explanations of the ODM error codes.

Implementation Specifics

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

Related Information

The odm_get_obj (odm_get_obj, odm_get_first, or odm_get_next Subroutine) subroutine, odm_open_class (odm_open_class Subroutine) subroutine.

The odmdelete command.

List of ODM Commands and Subroutines.

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