20002013 Ericsson AB. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. CosPropertyService_PropertiesIterator 2000-07-25 1.0
CosPropertyService_PropertiesIterator This module implements the OMG CosPropertyService::PropertiesIterator interface.

To get access to the record definitions for the structures use:

-include_lib("cosProperty/include/CosPropertyService.hrl").

 reset(Iterator) -> ok Reset the position to the first property Iterator = #objref

This operation resets the position to the first property.

next_one(Iterator) -> Reply Return true if a Property exists at the current position and the out parameter is a valid Property. Otherwise false and a non-valid property 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 Return true if the requested number of properties can be delivered and there are additional properties. Otherwise false is returned and a sequence of max HowManyproperties 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 Terminate the target object Iterator = #objref

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