Retrieves objects, one object at a time, from an ODM object class.
Object Data Manager Library (libodm.a)
#include <odmi.h>struct ClassName *odm_get_obj ( ClassSymbol, Criteria, ReturnData, FIRST_NEXT)struct ClassName *odm_get_first (ClassSymbol, Criteria, ReturnData)struct ClassName *odm_get_next (ClassSymbol, ReturnData)CLASS_SYMBOL ClassSymbol;
char *Criteria;
struct ClassName *ReturnData;
int FIRST_NEXT;The odm_get_obj, odm_get_first, and odm_get_next subroutines retrieve objects from ODM object classes and return the objects into C language structures defined by the .h file produced by the odmcreate command.
The odm_get_obj, odm_get_first, and odm_get_next subroutines open and close the specified object class if the object class was not previously opened. If the object class was previously opened, the subroutines leave the object class open upon return.
| Item | Description |
|---|---|
| ClassSymbol | Specifies a class symbol identifier returned from an odm_open_class subroutine. If the odm_open_class subroutine has not been called, then this identifier is the ClassName_CLASS structure that was created by the odmcreate command. |
| Criteria | Specifies the string that contains the qualifying criteria for retrieval of the objects. |
| ReturnData | Specifies the pointer to the data structure in the .h file
created by the odmcreate command. The name of the structure
in the .h file is ClassName. If the ReturnData parameter
is null (ReturnData == null), space is
allocated for the parameter and the calling application is responsible
for freeing this space at a later time. If variable length character strings (vchar) are returned, they are referenced by pointers in the ReturnData structure. Calling applications must free each vchar between each call to the odm_get subroutines; otherwise storage will be lost. |
| FIRST_NEXT | Specifies whether to get the first object that matches the
criteria or the next object. Valid values are:
|
Upon successful completion, a pointer to the retrieved object is returned. If no match is found, null is returned. If an odm_get_obj, odm_get_first, or odm_get_next subroutine is unsuccessful, a value of -1 is returned and the odmerrno variable is set to an error code.
Failure of the odm_get_obj, odm_get_first or odm_get_next subroutine sets the odmerrno variable to one of the following error codes:
See Object Data Manager (ODM) error codes in AIX® Version 7.1 Technical Reference: Base Operating System and Extensions, Volume 1 for explanations of the ODM error codes.