CosPropertyService_PropertiesIterator(3erl)

CosPropertyService_PropertiesIterator3erl

This module implements the omg cospropertyservice::propertiesiterator interface.

Overview

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.

Releases

7 releases since Debian 3.1 (Sarge); the text changed 6 times.

  1. 3.1
  2. 4.0
  3. 5.0
  4. 6.0
  5. 7
  6. 8
  7. 9

From erlang-manpages 1:19.2.1+dfsg-2+deb9u3 in Debian 9 (Stretch). Parsed by carta from the page's man source.