odm_free_list Subroutine

Base Operating System and Extensions Technical Reference, Volume 1

odm_free_list Subroutine

Purpose

Frees memory previously allocated for an odm_get_list subroutine.

Library

Object Data Manager Library (libodm.a)

Syntax

#include <odmi.h>

int odm_free_list (ReturnData, DataInfo)
struct ClassName *ReturnData;
struct listinfo *DataInfo;

Description

The odm_free_list subroutine recursively frees up a tree of memory object lists that were allocated for an odm_get_list subroutine.

Parameters

ReturnData	Points to the array of ClassName structures returned from the odm_get_list subroutine.
DataInfo	Points to the listinfo structure that was returned from the odm_get_list subroutine. The listinfo structure has the following form: struct listinfo { char ClassName[16]; /* class name for query / char criteria[256]; / query criteria / int num; / number of matches found / int valid; / for ODM use / CLASS_SYMBOL class; / symbol for queried class */ };

Return Values

Upon successful completion, a value of 0 is returned. If the odm_free_list 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_free_list subroutine sets the odmerrno variable to one of the following error codes:

ODMI_MAGICNO_ERR
	The class symbol does not identify a valid object class.
ODMI_PARAMS
	The parameters passed to the subroutine were not correct. Make sure there are the correct number of parameters and that they are valid.

Implementation Specifics

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

Related Information

The odm_get_list subroutine.

List of ODM Commands and Subroutines.

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