Erlang -- CosPropertyService_PropertyNamesIterator

User's Guide
Reference Manual
Release Notes
PDF
Top

cosProperty
Reference Manual
Version 1.2

Expand All
Contract All

Table of Contents

- cosProperty
  - Top of manual page
  - install/0
  - install_db/0
  - uninstall/0
  - uninstall_db/0
  - start/0
  - start_SetDefFactory/0
  - start_SetFactory/0
  - stop_SetDefFactory/1
  - stop_SetFactory/1
  - stop/0
- CosPropertyService_PropertySetFactory
  - Top of manual page
  - create_propertyset/1
  - create_constrained_propertyset/3
  - create_initial_propertyset/2
- CosPropertyService_PropertySetDefFactory
  - Top of manual page
  - create_propertysetdef/1
  - create_constrained_propertysetdef/3
  - create_initial_propertysetdef/2
- CosPropertyService_PropertySet
  - Top of manual page
  - define_property/3
  - define_properties/2
  - get_number_of_properties/1
  - get_all_property_names/2
  - get_property_value/2
  - get_properties/2
  - get_all_properties/2
  - delete_property/2
  - delete_properties/2
  - delete_all_properties/1
  - is_property_defined/2
- CosPropertyService_PropertySetDef
  - Top of manual page
  - get_allowed_property_types/1
  - get_allowed_properties/1
  - define_property_with_mode/4
  - define_properties_with_modes/2
  - get_property_mode/2
  - get_property_modes/2
  - set_property_mode/3
  - set_property_modes/2
- CosPropertyService_PropertiesIterator
  - Top of manual page
  - reset/1
  - next_one/1
  - next_n/2
  - destroy/1
- CosPropertyService_PropertyNamesIterator
  - Top of manual page
  - reset/1
  - next_one/1
  - next_n/2
  - destroy/1

# 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.