Technical Reference: Base Operating System and Extensions, Volume 1

odm_rm_obj Subroutine

Purpose

Removes objects from an ODM object class.

Library

Object Data Manager Library (libodm.a)

Syntax

#include <odmi.h>

int odm_rm_obj ( ClassSymbol, Criteria) CLASS_SYMBOL ClassSymbol; char *Criteria;

Description

The odm_rm_obj subroutine deletes objects from an object class.

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.
Criteria	Contains as a string the qualifying criteria for selecting the objects to remove.

Upon successful completion, the number of objects deleted is returned. If the odm_rm_obj 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_obj 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_add_obj (odm_add_obj Subroutine) subroutine, odm_open_class (odm_open_class Subroutine) subroutine.

The odmcreate command, 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.

For information on qualifying criteria, see "Understanding ODM Object Searches" in AIX 5L Version 5.1 General Programming Concepts: Writing and Debugging Programs.