PreviousNext
Help > API Functions > Objects > i5_objects_list
i5_objects_list

 

 Open an object list.

 

resource i5_objects_list (string library [, string name, string type ][, resource connection])

Parameters

 

 

library

Library name.

The following special values are allowed:
*ALL, *ALLUSR, *CURLIB, *LIBL, *USRLIBL

name

Name of objects to read.

The value can be a simple name, a generic name, or one the following special values:  *ALL, *ALLUSR, or *IBM.

Default is "*ALL".

type

Object type to fetch (*ALL or I5_ALL_OBJECTS for all)

connection

Connection - result of i5_connect

 

 

Return

 

Resource for fetch if everything is OK, false on error.

 

Error returned

I5_ERR_DESC_WRONG_DATAOP

41

Wrong operation on a data field of a description

I5_ERR_PARSEXML

42

Internal error; please contact Aura Equipements. error number 42

I5_ERR_PHP_OPTIONSTYPE

259

The type of " I5_OPTIONS_ALIAS" option must be x and not x

I5_ERR_PHP_OPTIONSNUMBER

260

Option number -1 is unknown.

I5_ERR_PHP_TYPEPARAM

262

Type of element x in parameter -1 must be y. Type z was provided.

 

 

Example

 

 

$HdlList = i5_objects_list('EASYCOM', 'S*', '*FILE');

if (is_bool($HdlList)) trigger_error('i5_objects_list error : '.i5_errormsg(), E_USER_ERROR);

 

$count = 0;

while($list = i5_objects_list_read($HdlList)){

 print_r($list);echo '<BR>';

 $count ++;

 if ($count > 3) break;

}

 

$ret = i5_objects_list_close($HdlList);

if (!$ret) trigger_error('i5_object_list_close error : '.i5_errormsg(), E_USER_ERROR);