Man pages sections > man3 > CosPropertyService_PropertiesIterator

CosPropertyService_PropertiesIterator - This module implements the OMG

CosPropertyService_PropertiesIterator(3erl) Erlang Module Definition CosPropertyService_PropertiesIterator(3erl)

NAME

CosPropertyService_PropertiesIterator - This module implements the OMG CosPropertyService::PropertiesIterator interface.

DESCRIPTION

To get access to the record definitions for the structures use:
 
-include_lib("cosProperty/include/CosPropertyService.hrl").

EXPORTS

reset(Iterator) -> ok
 
Types:
 
Iterator = #objref
 
This operation resets the position to the first property.
 
next_one(Iterator) -> Reply
 
Types:
 
Iterator = #objref
 
Reply = {boolean(), #'CosPropertyService_Property'{property_name = Name, property_value = Value}}
 
Name = string()
 
Value = #any
 
This operation returns true . If false is returned the out parameter is a non-valid Property.
 
next_n(Iterator, HowMany) -> Reply
 
Types:
 
Iterator = #objref
 
HowMany = long()
 
Reply = {boolean(), Properties}
 
Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]
 
Name = string()
 
Value = #any
 
This operation returns true if the requested number of properties can be delivered and there are additional properties. If false is returned and a sequence of max HowMany properties will be returned and no more properties can be delivered.
 
destroy(Iterator) -> ok
 
Types:
 
Iterator = #objref
 
This operation will terminate the Iterator and all subsequent calls will fail.
cosProperty 1.2.2 Ericsson AB