The R13B03 release.OTP_R13B03

1 files changed, 97 insertions, 0 deletions

diff --git a/lib/cosProperty/doc/src/CosPropertyService_PropertyNamesIterator.xml b/lib/cosProperty/doc/src/CosPropertyService_PropertyNamesIterator.xml
new file mode 100644
index 0000000000..54e29a5c01
--- /dev/null
+++ b/lib/cosProperty/doc/src/CosPropertyService_PropertyNamesIterator.xml
@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+  <header>
+    <copyright>
+      <year>2000</year>
+      <year>2007</year>
+      <holder>Ericsson AB, All Rights Reserved</holder>
+    </copyright>
+    <legalnotice>
+  The contents of this file are subject to the Erlang Public License,
+  Version 1.1, (the "License"); you may not use this file except in
+  compliance with the License. You should have received a copy of the
+  Erlang Public License along with this software. If not, it can be
+  retrieved online at http://www.erlang.org/.
+
+  Software distributed under the License is distributed on an "AS IS"
+  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+  the License for the specific language governing rights and limitations
+  under the License.
+
+  The Initial Developer of the Original Code is Ericsson AB.
+    </legalnotice>
+
+    <title>CosPropertyService_&shy;PropertyNamesIterator</title>
+    <shorttitle>..._PropertyNamesIterator</shorttitle>
+    <prepared>Niclas Eklund</prepared>
+    <responsible>Niclas Eklund</responsible>
+    <docno></docno>
+    <approved>Niclas Eklund</approved>
+    <checked></checked>
+    <date>2000-07-25</date>
+    <rev>1.0</rev>
+  </header>
+  <module>CosPropertyService_PropertyNamesIterator</module>
+  <modulesummary>This module implements the OMG CosPropertyService::PropertyNamesIterator interface.</modulesummary>
+  <description>
+    <p>To get access to the record definitions for the structures use:      <br></br>
+<c>-include_lib("cosProperty/include/CosPropertyService.hrl").</c></p>
+  </description>
+  <funcs>
+    <func>
+      <name>reset(Iterator) -> ok</name>
+      <fsummary>Reset the position to the first property name</fsummary>
+      <type>
+        <v>Iterator = #objref</v>
+      </type>
+      <desc>
+        <p>This operation resets the position to the first property name. </p>
+      </desc>
+    </func>
+    <func>
+      <name>next_one(Iterator) -> Reply</name>
+      <fsummary>Return true if a Property Name exists at the current  position and the out parameter is a valid Property Name. Otherwise false and a non-valid Property Name</fsummary>
+      <type>
+        <v>Iterator = #objref</v>
+        <v>Reply = {boolean(), Name}</v>
+        <v>Name = string()</v>
+      </type>
+      <desc>
+        <p>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.</p>
+      </desc>
+    </func>
+    <func>
+      <name>next_n(Iterator, HowMany) -> Reply</name>
+      <fsummary>Return <c>HowMany</c>Property Names and a boolean which is true if additional Property Names exists</fsummary>
+      <type>
+        <v>Iterator = #objref</v>
+        <v>HowMany = long()</v>
+        <v>Reply = {boolean(), [Name]}</v>
+        <v>Name = string()</v>
+      </type>
+      <desc>
+        <p>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 <c>HowMany</c> property names will be returned and no 
+          more Property Names can be delivered. </p>
+      </desc>
+    </func>
+    <func>
+      <name>destroy(Iterator) -> ok</name>
+      <fsummary>Terminate the target object</fsummary>
+      <type>
+        <v>Iterator = #objref</v>
+      </type>
+      <desc>
+        <p>This operation will terminate the Iterator and all subsequent calls
+          will fail. </p>
+      </desc>
+    </func>
+  </funcs>
+  
+</erlref>
+