Technical Reference: Base Operating System and Extensions, Volume 1

odm_get_by_id Subroutine

Purpose

Retrieves an object from an ODM object class by its ID.

Library

Object Data Manager Library (libodm.a)

Syntax

#include <odmi.h>

struct ClassName *odm_get_by_id( ClassSymbol, ObjectID, ReturnData) CLASS_SYMBOL ClassSymbol; int ObjectID; struct ClassName *ReturnData;

Description

The odm_get_by_id subroutine retrieves an object from an object class. The object to be retrieved is specified by passing its ObjectID parameter from its corresponding ClassName structure.

Parameters

ClassSymbol	Specifies a class symbol identifier of the form ClassName_CLASS, which is declared in the .h file created by the odmcreate command.
ObjectID	Specifies an identifier retrieved from the corresponding ClassName structure of the object class.
ReturnData	Specifies a pointer to an instance of the C language structure corresponding to the object class referenced by the ClassSymbol parameter. The structure is declared in the .h file created by the odmcreate command and has the same name as the object class.

Upon successful completion, a pointer to the ClassName structure containing the object is returned. If the odm_get_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_get_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), odm_get_first (odm_get_obj, odm_get_first, or odm_get_next Subroutine), or odm_get_next (odm_get_obj, odm_get_first, or odm_get_next Subroutine) subroutine.

The odmcreate command.

List of ODM Commands and Subroutines.

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

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