CosPropertyService_­PropertyNamesIterator

# CosPropertyService_PropertyNamesIterator

### MODULE

CosPropertyService_PropertyNamesIterator

### MODULE SUMMARY

This module implements the OMG CosPropertyService::PropertyNamesIterator 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 name.

`next_one(Iterator) -> Reply`

Types:

`Iterator = #objref`
`Reply = {boolean(), Name}`
`Name = string()`

This operation returns true if a Property Name exists at the current position and the out parameter is a valid Property Name. If false is returned the out parameter is a non-valid Property Name.

`next_n(Iterator, HowMany) -> Reply`

Types:

`Iterator = #objref`
`HowMany = long()`
`Reply = {boolean(), [Name]}`
`Name = string()`

This operation returns true if the requested number of Property Names can be delivered and there are additional property names. If false is returned a sequence of max `HowMany` property names will be returned and no more Property Names can be delivered.

`destroy(Iterator) -> ok`

Types:

`Iterator = #objref`

This operation will terminate the Iterator and all subsequent calls will fail.

### AUTHORS

Niclas Eklund - support@erlang.ericsson.se

cosProperty 1.1.1
Copyright © 1991-2006 Ericsson AB