TOC PREV NEXT INDEX

OMget_port_list

Synopsis


int OMget_port_list(OMobj_id object_id,int
*num_ports,OMobj_id **port_list,int mode)

Description

This routine returns the list of ports for object_id. A subobject is placed in the list of ports returned if it has the NEportLevels or exported property set to a value greater than or equal to the number of levels down in the hierarchy it is removed from object_id.

Arguments

object_id
The object whose ports are returned.
num_ports
The number of ports in object_id.
port_list
An array of the object ids of the ports in object_id. If the num_ports value is greater than 0, you should free this array when you are finished with it using the C library routine free.
mode
A value of 0 allows this object to be included in its own list of ports if it has the NEportLevels or exported property set to 1 or greater. A value OM_PORTS_NO_TOP_LEVEL prevents this object from being included in its own list of ports.

Returned value

The status code (see Return Status ).

Examples

none.

See Also

none.

TOC PREV NEXT INDEX