From: <wda...@us...> - 2008-12-22 16:48:15
|
Revision: 3802 http://oorexx.svn.sourceforge.net/oorexx/?rev=3802&view=rev Author: wdashley Date: 2008-12-22 16:48:11 +0000 (Mon, 22 Dec 2008) Log Message: ----------- First try for documenting the C++ APIs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2008-12-22 04:13:12 UTC (rev 3801) +++ docs/trunk/rexxpg/api.sgml 2008-12-22 16:48:11 UTC (rev 3802) @@ -93,6 +93,16 @@ provides.</para> </section> +<section id="methodapi"><title>Rexx Method Interface</title> +<para>This section describes the Rexx method interface and the methods it +provides.</para> +</section> + +<section id="functionapi"><title>Rexx Function Interface</title> +<para>This section describes the Rexx external function interface and the methods it +provides.</para> +</section> + <section id="buildinglibs"><title>Building an External Library</title> <para>This section describes how to build an external library.</para> </section> @@ -100,4 +110,61 @@ <section id="exitsapi"><title>Rexx Exits Interface</title> <para>This section describes how to define a Rexx exit.</para> </section> + +<section id="apilisting"><title>Rexx Methods Listing</title> +<para>This section describes each available method and its associated context.</para> + +<section id="mthGetApplicationData"><title>GetApplicationData</title> +<indexterm><primary>GetApplicationData</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetApplicationData</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetApplicationData</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetApplicationData</secondary></indexterm> +<para>The GetApplicationData method returns a pointer to the thread specific application data. +</para> +<programlisting> +<![CDATA[ +>>--ptr = context->GetApplicationData();------------------------------>< +]]> +</programlisting> +<table frame="all"> +<title>Available Contexts</title> +<tgroup cols="2"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row> +<entry>Thread</entry> +<entry>Yes</entry> +</row> +<row> +<entry>Method</entry> +<entry>Yes</entry> +</row> +<row> +<entry>Function</entry> +<entry>Yes</entry> +</row> +</tbody> +</tgroup> +</table> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A Pointer to the application data.</para> +</section> +</section> + + + + + + + +</section> </appendix> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2008-12-28 18:14:25
|
Revision: 3818 http://oorexx.svn.sourceforge.net/oorexx/?rev=3818&view=rev Author: wdashley Date: 2008-12-28 18:14:22 +0000 (Sun, 28 Dec 2008) Log Message: ----------- More API docs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2008-12-28 16:31:01 UTC (rev 3817) +++ docs/trunk/rexxpg/api.sgml 2008-12-28 18:14:22 UTC (rev 3818) @@ -83,13 +83,13 @@ them.</para> </section> -<section id="instanceapi"><title>Rexx Instance Interface</title> -<para>This section describes the Rexx instance interface and the methods it +<section id="instanceapi"><title>Rexx Interpreter Instance Interface</title> +<para>This section describes the Rexx interpreter instance interface and the methods it provides.</para> </section> -<section id="threadapi"><title>Rexx Thread Interface</title> -<para>This section describes the Rexx thread interface and the methods it +<section id="threadapi"><title>Rexx Thread Instance Interface</title> +<para>This section describes the Rexx thread instance interface and the methods it provides.</para> </section> @@ -114,6 +114,48 @@ <section id="apilisting"><title>Rexx Methods Listing</title> <para>This section describes each available method and its associated context.</para> +<section id="mthAttachThread"><title>AttachThread</title> +<indexterm><primary>AttachThread</primary></indexterm> +<indexterm><primary>Rexx instance context methods</primary> +<secondary>AttachThread</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>Yes</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxThreadContext *tc + +>>--success = context->AttachThread(&tc);------------------------------->< +]]> +</programlisting> +<para>Attaches the current thread to the Rexx interpreter instance pointed to by the +<emphasis role="italic">context</emphasis> pointer. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">tc</emphasis></term> + <listitem><para>Pointer to a RexxThreadContext pointer.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Boolean value. 0 = success, 1 = failure.</para> +</section> +</section> + <section id="mthGetApplicationData"><title>GetApplicationData</title> <indexterm><primary>GetApplicationData</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -122,41 +164,220 @@ <secondary>GetApplicationData</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>GetApplicationData</secondary></indexterm> -<para>The GetApplicationData method returns a pointer to the thread specific application data. -</para> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> <programlisting> <![CDATA[ >>--ptr = context->GetApplicationData();------------------------------>< ]]> </programlisting> -<table frame="all"> -<title>Available Contexts</title> +<para>Returns a pointer to the thread specific application data. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A Pointer to the application data.</para> +</section> +</section> + +<section id="mthHalt"><title>Halt</title> +<indexterm><primary>Halt</primary></indexterm> +<indexterm><primary>Rexx instance context methods</primary> +<secondary>Halt</secondary></indexterm> +<informaltable frame="all"> <tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> <tbody> <row> <entry><emphasis role="bold">Context</emphasis></entry> <entry><emphasis role="bold">Available</emphasis></entry> </row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>Yes</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +>>--context->Halt();----------------------------------------------------->< +]]> +</programlisting> +<para>Halts the interpreter. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthInterpreterVersion"><title>InterpreterVersion</title> +<indexterm><primary>InterpreterVersion</primary></indexterm> +<indexterm><primary>Rexx instance context methods</primary> +<secondary>InterpreterVersion</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> <row> -<entry>Thread</entry> -<entry>Yes</entry> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> </row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>Yes</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +suze_t version; + +>>--version = context->InterpreterVersion();---------------------------->< +]]> +</programlisting> +<para>Returns the version of the interpreter. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>The interpreter version number.</para> +</section> +</section> + +<section id="mthLanguageLevel"><title>Language Level</title> +<indexterm><primary>Language Level</primary></indexterm> +<indexterm><primary>Rexx instance context methods</primary> +<secondary>LanguageLevel</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> <row> -<entry>Method</entry> -<entry>Yes</entry> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> </row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>Yes</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +suze_t langlevel; + +>>--langlevel = context->LanguageLevel();------------------------------->< +]]> +</programlisting> +<para>Returns the language blevel of the interpreter. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>The interpreter language level number.</para> +</section> +</section> + +<section id="mthSetTrace"><title>SetTrace</title> +<indexterm><primary>SetTrace</primary></indexterm> +<indexterm><primary>Rexx instance context methods</primary> +<secondary>SetTrace</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> <row> -<entry>Function</entry> -<entry>Yes</entry> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> </row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>Yes</entry></row> </tbody> </tgroup> -</table> +</informaltable> +<programlisting> +<![CDATA[ +logical_t flag; + +>>--context->SetTrace(flag);--------------------------------------------->< +]]> +</programlisting> +<para>Sets the trace flag of the interpreter. +</para> <section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">flag</emphasis></term> + <listitem><para>Logical boolean flag.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthTerminate"><title>Terminate</title> +<indexterm><primary>Terminate</primary></indexterm> +<indexterm><primary>Rexx instance context methods</primary> +<secondary>Terminate</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>Yes</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +>>--context->Terminate();---------------------------------------------->< +]]> +</programlisting> +<para>Terminates the current Rexx interpreter instance and releases +all storage associated with that instance. +</para> +<section><title>Arguments</title> <para>None.</para> </section> <section><title>Returns</title> -<para>A Pointer to the application data.</para> +<para>Void.</para> </section> </section> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-05 15:28:05
|
Revision: 3871 http://oorexx.svn.sourceforge.net/oorexx/?rev=3871&view=rev Author: wdashley Date: 2009-01-05 15:28:00 +0000 (Mon, 05 Jan 2009) Log Message: ----------- More oo api updates. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-05 04:17:10 UTC (rev 3870) +++ docs/trunk/rexxpg/api.sgml 2009-01-05 15:28:00 UTC (rev 3871) @@ -88,8 +88,8 @@ provides.</para> </section> -<section id="threadapi"><title>Rexx Thread Instance Interface</title> -<para>This section describes the Rexx thread instance interface and the methods it +<section id="threadapi"><title>Rexx Thread Interface</title> +<para>This section describes the Rexx thread interface and the methods it provides.</para> </section> @@ -156,6 +156,138 @@ </section> </section> +<section id="mthDetachThread"><title>DetachThread</title> +<indexterm><primary>DetachThread</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>DetachThread</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>Nos</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +>>--context->DetachThread()-------------;------------------------------->< +]]> +</programlisting> +<para>Detaches the current thread to the Rexx thread instance pointed to by the +<emphasis role="italic">context</emphasis> pointer. +</para> +<section><title>Arguments</title> +<para>None</para> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthFindClass"><title>FindClass</title> +<indexterm><primary>FindClass</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>FindClass</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>FindClass</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>FindClass</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxClassObject class; +CSTRING name; + +>>--class = context->FindClass(name);--------------------------------->< +]]> +</programlisting> +<para>Returns a pointer to the specified class object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>An ASCIIZ string containing the name of the class.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to the class object.</para> +</section> +</section> + +<section id="mthFindPackageClass"><title>FindPackageClass</title> +<indexterm><primary>FindPackageClass</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>FindPClass</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>FindPackageClass</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>FindPackageClass</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxPackageObject pkg; +RexxClassObject class; +CSTRING name; + +>>--class = context->FindPackageClass(pkg, name);--------------------->< +]]> +</programlisting> +<para>Returns a pointer to the specified class object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">pkg</emphasis></term> + <listitem><para>The package object which contains the class.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>An ASCIIZ string containing the name of the class.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to the class object.</para> +</section> +</section> + <section id="mthGetApplicationData"><title>GetApplicationData</title> <indexterm><primary>GetApplicationData</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -195,6 +327,88 @@ </section> </section> +<section id="mthGetGlobalEnvironment"><title>GetGlobalEnvironment</title> +<indexterm><primary>GetGlobalEnvironment</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetGlobalEnvironment</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetGlobalEnvironment</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetGlobalEnvironment</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dir; + +>>--dir = context->GetGlobalEnvironment();---------------------------->< +]]> +</programlisting> +<para>Returns a pointer to a RexxDirectoryObject which contains the global environment variables and their values. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A Pointer to a RexxDirectoryObject.</para> +</section> +</section> + +<section id="mthGetLocalEnvironment"><title>GetLocalEnvironment</title> +<indexterm><primary>GetLocalEnvironment</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetLocalEnvironment</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetLocalEnvironment</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetLocalEnvironment</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dir; + +>>--dir = context->GetLocalEnvironment();----------------------------->< +]]> +</programlisting> +<para>Returns a pointer to a RexxDirectoryObject which contains the local environment variables and their values. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A Pointer to a RexxDirectoryObject.</para> +</section> +</section> + <section id="mthHalt"><title>Halt</title> <indexterm><primary>Halt</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> @@ -230,6 +444,92 @@ </section> </section> +<section id="mthHaltThread"><title>HaltThread</title> +<indexterm><primary>HaltThread</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>HaltThread</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>Nos</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +>>--context->HaltThread();---------------------------------------------->< +]]> +</programlisting> +<para>Halts the current thread pointed to by the +<emphasis role="italic">context</emphasis> pointer. +</para> +<section><title>Arguments</title> +<para>None</para> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthHasMethod"><title>HasMethod</title> +<indexterm><primary>HasMethod</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>HasMethod</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>HasMethod</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>HasMethod</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Tes</entry></row> +<row><entry>Function</entry><entry>Tes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +logical_t flag; +RexxObjectPtr obj; +CSTRING name; + +>>--flag = context->HasMethod(obj, name);------------------------------->< +]]> +</programlisting> +<para>Returns a boolean indicating if an object has the specified method available. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to query.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>An ASCIIZ string containing the name of the method.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>1 = has the method available, 0 = does not have the method available.</para> +</section> +</section> + <section id="mthInterpreterVersion"><title>InterpreterVersion</title> <indexterm><primary>InterpreterVersion</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> @@ -243,16 +543,16 @@ <entry><emphasis role="bold">Context</emphasis></entry> <entry><emphasis role="bold">Available</emphasis></entry> </row> -<row><entry>Thread</entry><entry>No</entry></row> -<row><entry>Method</entry><entry>No</entry></row> -<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Tes</entry></row> +<row><entry>Function</entry><entry>Tes</entry></row> <row><entry>Interpreter</entry><entry>Yes</entry></row> </tbody> </tgroup> </informaltable> <programlisting> <![CDATA[ -suze_t version; +size_t version; >>--version = context->InterpreterVersion();---------------------------->< ]]> @@ -267,7 +567,107 @@ </section> </section> -<section id="mthLanguageLevel"><title>Language Level</title> +<section id="mthIsInstanceOf"><title>IsInstanceOf</title> +<indexterm><primary>IsInstanceOf</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>IsInstanceOf</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>IsInstanceOf</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>IsInstanceOf</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +RexxClassObj class; +logical_t flag; + +>>--flag = context->IsInstanceOf(obj, class);--------------------------->< +]]> +</programlisting> +<para>Tests an object to see if is an instance of or an instance of a subclass of the specified class. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">class</emphasis></term> + <listitem><para>A pointer to the Rexx class object to be tested for membership.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>1 = is a member, 0 = not a member.</para> +</section> +</section> + +<section id="mthIsOfType"><title>IsOfType</title> +<indexterm><primary>IsOfType</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>IsOfType</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>IsOfType</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>IsOfType</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +CSTRING class; +logical_t flag; + +>>--flag = context->IsOfType(obj, class);------------------------------->< +]]> +</programlisting> +<para>Tests an object to see if is an instance of or an instance of a subclass of the specified class. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">class</emphasis></term> + <listitem><para>An ASCIIZ string containing the name of the Rexx class. This string will automatically be converted to upper case.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>1 = is a member, 0 = not a member.</para> +</section> +</section> + +<section id="mthLanguageLevel"><title>LanguageLevel</title> <indexterm><primary>Language Level</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> <secondary>LanguageLevel</secondary></indexterm> @@ -280,16 +680,16 @@ <entry><emphasis role="bold">Context</emphasis></entry> <entry><emphasis role="bold">Available</emphasis></entry> </row> -<row><entry>Thread</entry><entry>No</entry></row> -<row><entry>Method</entry><entry>No</entry></row> -<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Tes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>Yes</entry></row> </tbody> </tgroup> </informaltable> <programlisting> <![CDATA[ -suze_t langlevel; +size_t langlevel; >>--langlevel = context->LanguageLevel();------------------------------->< ]]> @@ -304,6 +704,390 @@ </section> </section> +<section id="mthReleaseGlobalReference"><title>ReleaseGlobalReference</title> +<indexterm><primary>ReleaseGlobalReference</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ReleaseGlobalReference</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ReleaseGlobalReference</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ReleaseGlobalReference</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr ref; + +>>--context->RequestGlobalReference(ref);-------------------------------->< +]]> +</programlisting> +<para>Release access to a global object reference. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">ref</emphasis></term> + <listitem><para>A pointer to the global Rexx object reference.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthReleaseLocalReference"><title>ReleaseLocalReference</title> +<indexterm><primary>ReleaseLocalReference</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ReleaseLocalReference</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ReleaseLocalReference</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ReleaseLocalReference</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr ref; + +>>--context->RequestLocalReference(ref);--------------------------------->< +]]> +</programlisting> +<para>Release access to a local object reference. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">ref</emphasis></term> + <listitem><para>A pointer to the local Rexx object reference.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthRequestGlobalReference"><title>RequestGlobalReference</title> +<indexterm><primary>RequestGlobalReference</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>RequestGlobalReference</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>RequestGlobalReference</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>RequestGlobalReference</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr ref, obj; + +>>--ref = context->RequestGlobalReference(obj);-------------------------->< +]]> +</programlisting> +<para>Request access to a global object reference. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>Rexx object containing the name of the global object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the global Rexx object or NULL if the object was not found.</para> +</section> +</section> + +<section id="mthSendMessage"><title>SendMessage</title> +<indexterm><primary>SendMessage</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>SendMessage</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>SendMessage</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>SendMessage</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj, ret; +RexxArrayObject arr; + +>>--ret = context->SendMessage(obj, meg, arr);--------------------------->< +]]> +</programlisting> +<para>Send a message to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The object to receive the message.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">msg</emphasis></term> + <listitem><para>An ASCIIZ string containing the message name. This argument will be converted to upper case automatically.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>The array of message arguments.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the returned Rexx object. If the method does not return an object then NULL is returned.</para> +</section> +</section> + +<section id="mthSendMessage0"><title>SendMessage0</title> +<indexterm><primary>SendMessage0</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>SendMessage0</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>SendMessage0</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>SendMessage0</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj, ret; + +>>--ret = context->SendMessage0(obj, meg);------------------------------->< +]]> +</programlisting> +<para>Send a message to a Rexx object. +This is a short cut method when no arguments are needed by the receiving object method. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The object to receive the message.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">msg</emphasis></term> + <listitem><para>An ASCIIZ string containing the message name. This argument will be converted to upper case automatically.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the returned Rexx object. If the method does not return an object then NULL is returned.</para> +</section> +</section> + +<section id="mthSendMessage1"><title>SendMessage1</title> +<indexterm><primary>SendMessage1</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>SendMessage1</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>SendMessage1</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>SendMessage1</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj, ret, arg1; + +>>--ret = context->SendMessage2(obj, meg, arg1);------------------------->< +]]> +</programlisting> +<para>Send a message to a Rexx object. +This is a short cut method when only one argument is needed by the receiving object method. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The object to receive the message.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">msg</emphasis></term> + <listitem><para>An ASCIIZ string containing the message name. This argument will be converted to upper case automatically.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">arg1</emphasis></term> + <listitem><para>The first argument to the receiving method.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the returned Rexx object. If the method does not return an object then NULL is returned.</para> +</section> +</section> + +<section id="mthSendMessage2"><title>SendMessage2</title> +<indexterm><primary>SendMessage2</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>SendMessage2</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>SendMessage2</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>SendMessage2</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj, ret, arg1, arg2; + +>>--ret = context->SendMessage2(obj, meg, arg1, arg2);------------------->< +]]> +</programlisting> +<para>Send a message to a Rexx object. +This is a short cut method when only one argument is needed by the receiving object method. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The object to receive the message.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">msg</emphasis></term> + <listitem><para>An ASCIIZ string containing the message name. This argument will be converted to upper case automatically.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">arg1</emphasis></term> + <listitem><para>The first argument to the receiving method.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">arg2</emphasis></term> + <listitem><para>The second argument to the receiving method.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the returned Rexx object. If the method does not return an object then NULL is returned.</para> +</section> +</section> + +<section id="mthSetThreadTrace"><title>SetThreadTrace</title> +<indexterm><primary>SetThreadTrace</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>SetThreadTrace</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +logical_t flag; + +>>--context->SetThreadTrace(flag);--------------------------------------->< +]]> +</programlisting> +<para>Sets the current thread trace flag of the interpreter. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">flag</emphasis></term> + <listitem><para>Logical boolean flag.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + <section id="mthSetTrace"><title>SetTrace</title> <indexterm><primary>SetTrace</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-05 19:12:34
|
Revision: 3873 http://oorexx.svn.sourceforge.net/oorexx/?rev=3873&view=rev Author: wdashley Date: 2009-01-05 19:12:29 +0000 (Mon, 05 Jan 2009) Log Message: ----------- More oo api docs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-05 16:16:16 UTC (rev 3872) +++ docs/trunk/rexxpg/api.sgml 2009-01-05 19:12:29 UTC (rev 3873) @@ -156,6 +156,105 @@ </section> </section> +<section id="mthCallProgram"><title>CallProgram</title> +<indexterm><primary>CallProgram</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>CallProgram</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>CallProgram</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>CallProgram</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +CSTRING name; +RexxObjectPtr ret; +RexxArrayObject arr; + +>>--ret = context->CallProgram(name, arr);---------------------------->< +]]> +</programlisting> +<para>Returns the result object of the routine. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>The ASCIIZ path/name of the Rexx program to call.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>The array of Rexx object arguments to the specified program.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to the result Rexx object returned by the program.</para> +</section> +</section> + +<section id="mthCallRoutine"><title>CallRoutine</title> +<indexterm><primary>CallRoutine</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>CallRoutine</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>CallRoutine</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>CallRoutine</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj, ret; +RexxArrayObject arr; + +>>--ret = context->CallRoutine(obj, arr);----------------------------->< +]]> +</programlisting> +<para>Returns the result object of the routine. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx routine object to call.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>The array of Rexx object arguments to the specified routine.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to the result Rexx object returned by the routine.</para> +</section> +</section> + <section id="mthDetachThread"><title>DetachThread</title> <indexterm><primary>DetachThread</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -409,6 +508,328 @@ </section> </section> +<section id="mthGetMethodPackage"><title>GetMethodPackage</title> +<indexterm><primary>GetMethodPackage</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetMethodPackage</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetMethodPackage</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetMethodPackage</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxMethodObject obj; +RexxPackageObject pkg; + +>>--pkg = context->GetMethodPackage(obj);----------------------------->< +]]> +</programlisting> +<para>Returns a pointer to a RexxPackageObject which contains the specified method object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx method object to query.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to a RexxPackageObject.</para> +</section> +</section> + +<section id="mthGetPackageClasses"><title>GetPackageClasses</title> +<indexterm><primary>GetPackageClasses</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetPackageClasses</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetPackageClasses</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetPackageClasses</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dir; +RexxPackageObject pkg; + +>>--dir = context->GetPackageClasses(pkg);---------------------------->< +]]> +</programlisting> +<para>Returns a RexxDirectoryObject pointer which contains the public and private classes (name and object) from the specified package object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx package object to query.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to a RexxDirectoryObject.</para> +</section> +</section> + +<section id="mthGetPackageMethods"><title>GetPackageMethods</title> +<indexterm><primary>GetPackageMethods</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetPackageMethods</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetPackageMethods</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetPackageMethods</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dir; +RexxPackageObject pkg; + +>>--dir = context->GetPackageMethods(pkg);---------------------------->< +]]> +</programlisting> +<para>Returns a RexxDirectoryObject pointer which contains the public unattached methods (name and object) from the specified package object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx package routine object to query.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to a RexxDirectoryObject.</para> +</section> +</section> + +<section id="mthGetPackagePublicClasses"><title>GetPackagePublicClasses</title> +<indexterm><primary>GetPackagePublicClasses</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetPackagePublicClasses</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetPackagePublicClasses</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetPackagePublicClasses</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dir; +RexxPackageObject pkg; + +>>--dir = context->GetPackagePublicClasses(pkg);---------------------->< +]]> +</programlisting> +<para>Returns a RexxDirectoryObject pointer which contains the public classes (name and object) from the specified package object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx package object to query.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to a RexxDirectoryObject.</para> +</section> +</section> + +<section id="mthGetPackagePublicRoutines"><title>GetPackagePublicRoutines</title> +<indexterm><primary>GetPackagePublicRoutines</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetPackagePublicRoutines</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetPackagePublicRoutines</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetPackagePublicRoutines</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dir; +RexxPackageObject pkg; + +>>--dir = context->GetPackagePublicRoutines(pkg);--------------------->< +]]> +</programlisting> +<para>Returns a RexxDirectoryObject pointer which contains the public routines (name and object) from the specified package object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx package object to query.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to a RexxDirectoryObject.</para> +</section> +</section> + +<section id="mthGetPackageRoutines"><title>GetPackageRoutines</title> +<indexterm><primary>GetPackageRoutines</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetPackageRoutines</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetPackageRoutines</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetPackageRoutines</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dir; +RexxPackageObject pkg; + +>>--dir = context->GetPackageRoutines(pkg);--------------------------->< +]]> +</programlisting> +<para>Returns a RexxDirectoryObject pointer which contains the public and private routines (name and object) from the specified package object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx package routine object to query.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to a RexxDirectoryObject.</para> +</section> +</section> + +<section id="mthGetRoutinePackage"><title>GetRoutinePackage</title> +<indexterm><primary>GetRoutinePackage</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetRoutinePackage</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetRoutinePackage</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetRoutinePackage</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxRoutineObject obj; +RexxPackageObject pkg; + +>>--pkg = context->GetRoutinePackage(obj);---------------------------->< +]]> +</programlisting> +<para>Returns a pointer to a RexxPackageObject which contains the specified routine object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx routine object to query.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to a RexxPackageObject.</para> +</section> +</section> + <section id="mthHalt"><title>Halt</title> <indexterm><primary>Halt</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> @@ -667,6 +1088,98 @@ </section> </section> +<section id="mthIsMethod"><title>IsMethod</title> +<indexterm><primary>IsMethod</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>IsMethod</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>IsMethod</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>IsMethod</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; + +>>--flag = context->IsMethod(obj);-------------------------------------->< +]]> +</programlisting> +<para>Tests an object to see if is a RexxMethodObject. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>1 = is a method, 0 = not a method.</para> +</section> +</section> + +<section id="mthIsRoutine"><title>IsRoutine</title> +<indexterm><primary>IsRoutine</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>IsRoutine</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>IsRoutine</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>IsRoutine</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; + +>>--flag = context->IsRoutine(obj);------------------------------------->< +]]> +</programlisting> +<para>Tests an object to see if is a RexxRoutineObject. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>1 = is a routine, 0 = not a routine.</para> +</section> +</section> + <section id="mthLanguageLevel"><title>LanguageLevel</title> <indexterm><primary>Language Level</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> @@ -704,6 +1217,257 @@ </section> </section> +<section id="mthLoadPackage"><title>LoadPackage</title> +<indexterm><primary>LoadPackage</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>LoadPackage</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>LoadPackage</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>LoadPackage</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +CSTRING name; +RexxPackageObject pkg; + +>>--pkg = context->LoadPackage(name);--------------------------------->< +]]> +</programlisting> +<para>Returns the loaded package object from the specified file path/name. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>The ASCIIZ path/name of the Rexx package to load.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to the loaded package object.</para> +</section> +</section> + +<section id="mthLoadPackage"><title>LoadPackageFromData</title> +<indexterm><primary>LoadPackageFromData</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>LoadPackageFromData</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>LoadPackageFromData</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>LoadPackageFromData</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +CSTRING name, data; +size_t sz; +RexxPackageObject pkg; + +>>--pkg = context->LoadPackageFromData(name, data, sz);--------------->< +]]> +</programlisting> +<para>Returns the loaded package object from the specified file path/name. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>The ASCIIZ name of the Rexx package to load.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">data</emphasis></term> + <listitem><para>String containing the ooRexx code of the package to load.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">sz</emphasis></term> + <listitem><para>The size of the <emphasis role="italic">data</emphasis> string.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to the loaded package object.</para> +</section> +</section> + +<section id="mthNewMethod"><title>NewMethod</title> +<indexterm><primary>NewMethod</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>NewMethod</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>NewMethod</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>NewMethod</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxMethodObject obj; +CSTRING name, code; +size_t sz; + +>>--obj = context->NewMethod(name, code, sz);---------------------------->< +]]> +</programlisting> +<para>Add a new method to the cuurrent context (method, function or thread). +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>ASCIIZ name of the Rexx method.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">code</emphasis></term> + <listitem><para>String containing the ooRexx code for the new method.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">sz</emphasis></term> + <listitem><para>Size of the <emphasis role="italic">code</emphasis> string.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the new RexxMethodObject.</para> +</section> +</section> + +<section id="mthNewRoutine"><title>NewRoutine</title> +<indexterm><primary>NewRoutine</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>NewRoutine</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>NewRoutine</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>NewRoutine</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxRoutineObject obj; +CSTRING name, code; +size_t sz; + +>>--obj = context->NewRoutine(name, code, sz);--------------------------->< +]]> +</programlisting> +<para>Add a new routine to the cuurrent context (method, function or thread). +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>ASCIIZ name of the Rexx routine.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">code</emphasis></term> + <listitem><para>String containing the ooRexx code for the new routine.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">sz</emphasis></term> + <listitem><para>Size of the <emphasis role="italic">code</emphasis> string.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the new RexxRoutineObject.</para> +</section> +</section> + +<section id="mthObjectToCSelf"><title>ObjectToCSelf</title> +<indexterm><primary>ObjectToCSelf</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToCSelf</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToCSelf</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToCSelf</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +POINTER ptr; + +>>--ptr = context->ObjectToCSelf(obj);-------------------------------->< +]]> +</programlisting> +<para>Returns a pointer to the specified Rexx object that can be saved for later use. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Pointer to the Rexx object.</para> +</section> +</section> + <section id="mthReleaseGlobalReference"><title>ReleaseGlobalReference</title> <indexterm><primary>ReleaseGlobalReference</primary></indexterm> <indexterm><primary>Thread context methods</primary> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-05 19:15:08
|
Revision: 3874 http://oorexx.svn.sourceforge.net/oorexx/?rev=3874&view=rev Author: wdashley Date: 2009-01-05 19:15:04 +0000 (Mon, 05 Jan 2009) Log Message: ----------- Oops! Correct small id error. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-05 19:12:29 UTC (rev 3873) +++ docs/trunk/rexxpg/api.sgml 2009-01-05 19:15:04 UTC (rev 3874) @@ -1263,7 +1263,7 @@ </section> </section> -<section id="mthLoadPackage"><title>LoadPackageFromData</title> +<section id="mthLoadPackageFromData"><title>LoadPackageFromData</title> <indexterm><primary>LoadPackageFromData</primary></indexterm> <indexterm><primary>Thread context methods</primary> <secondary>LoadPackageFromData</secondary></indexterm> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-06 16:02:12
|
Revision: 3877 http://oorexx.svn.sourceforge.net/oorexx/?rev=3877&view=rev Author: wdashley Date: 2009-01-06 16:02:11 +0000 (Tue, 06 Jan 2009) Log Message: ----------- More oo api docs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-06 06:07:33 UTC (rev 3876) +++ docs/trunk/rexxpg/api.sgml 2009-01-06 16:02:11 UTC (rev 3877) @@ -130,6 +130,7 @@ <row><entry>Thread</entry><entry>No</entry></row> <row><entry>Method</entry><entry>No</entry></row> <row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> <row><entry>Interpreter</entry><entry>Yes</entry></row> </tbody> </tgroup> @@ -164,6 +165,8 @@ <secondary>CallProgram</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>CallProgram</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>CallProgram</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -176,6 +179,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -214,6 +218,8 @@ <secondary>CallRoutine</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>CallRoutine</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>CallRoutine</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -226,6 +232,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -271,6 +278,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>No</entry></row> <row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> <row><entry>Interpreter</entry><entry>Nos</entry></row> </tbody> </tgroup> @@ -299,6 +307,8 @@ <secondary>FindClass</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>FindClass</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>FindClass</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -311,6 +321,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -345,6 +356,8 @@ <secondary>FindPackageClass</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>FindPackageClass</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>FindPackageClass</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -357,6 +370,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -395,6 +409,8 @@ <secondary>GetApplicationData</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>GetApplicationData</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetApplicationData</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -407,6 +423,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -434,6 +451,8 @@ <secondary>GetGlobalEnvironment</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>GetGlobalEnvironment</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetGlobalEnvironment</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -446,6 +465,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -475,6 +495,8 @@ <secondary>GetLocalEnvironment</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>GetLocalEnvironment</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetLocalEnvironment</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -487,6 +509,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -516,6 +539,8 @@ <secondary>GetMethodPackage</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>GetMethodPackage</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetMethodPackage</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -528,6 +553,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -562,6 +588,8 @@ <secondary>GetPackageClasses</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>GetPackageClasses</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetPackageClasses</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -574,6 +602,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -608,6 +637,8 @@ <secondary>GetPackageMethods</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>GetPackageMethods</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetPackageMethods</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -620,6 +651,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -654,6 +686,8 @@ <secondary>GetPackagePublicClasses</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>GetPackagePublicClasses</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetPackagePublicClasses</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -666,6 +700,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -700,6 +735,8 @@ <secondary>GetPackagePublicRoutines</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>GetPackagePublicRoutines</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetPackagePublicRoutines</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -712,6 +749,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -746,6 +784,8 @@ <secondary>GetPackageRoutines</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>GetPackageRoutines</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetPackageRoutines</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -758,6 +798,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -792,6 +833,8 @@ <secondary>GetRoutinePackage</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>GetRoutinePackage</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetRoutinePackage</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -804,6 +847,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -846,6 +890,7 @@ <row><entry>Thread</entry><entry>No</entry></row> <row><entry>Method</entry><entry>No</entry></row> <row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> <row><entry>Interpreter</entry><entry>Yes</entry></row> </tbody> </tgroup> @@ -881,6 +926,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>No</entry></row> <row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> <row><entry>Interpreter</entry><entry>Nos</entry></row> </tbody> </tgroup> @@ -909,6 +955,8 @@ <secondary>HasMethod</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>HasMethod</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>HasMethod</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -921,6 +969,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Tes</entry></row> <row><entry>Function</entry><entry>Tes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -953,6 +1002,14 @@ <section id="mthInterpreterVersion"><title>InterpreterVersion</title> <indexterm><primary>InterpreterVersion</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>InterpreterVersion</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>InterpreterVersion</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>InterpreterVersion</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>InterpreterVersion</secondary></indexterm> <indexterm><primary>Rexx instance context methods</primary> <secondary>InterpreterVersion</secondary></indexterm> <informaltable frame="all"> @@ -967,6 +1024,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Tes</entry></row> <row><entry>Function</entry><entry>Tes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>Yes</entry></row> </tbody> </tgroup> @@ -988,6 +1046,105 @@ </section> </section> +<section id="mthIntptr"><title>Intptr</title> +<indexterm><primary>Intptr</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>Intptr</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>Intptr</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>Intptr</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>Intptr</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +intptr_t n; + +>>--obj = context->Intptr(n);-------------------------------------------->< +]]> +</programlisting> +<para>Convert a C signed integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +Alias of the <link linkend="mthIntptrToObject">IntptrToObject</link> method. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the signed interger to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C signed integer.</para> +</section> +</section> + +<section id="mthIntptrToObject"><title>IntptrToObject</title> +<indexterm><primary>IntptrToObject</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>IntptrToObject</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>IntptrToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>IntptrToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>IntptrToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +intptr_t n; + +>>--obj = context->IntptrToObject(n);------------------------------------>< +]]> +</programlisting> +<para>Convert a C signed integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the signed interger to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C signed integer.</para> +</section> +</section> + <section id="mthIsInstanceOf"><title>IsInstanceOf</title> <indexterm><primary>IsInstanceOf</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -996,6 +1153,8 @@ <secondary>IsInstanceOf</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>IsInstanceOf</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>IsInstanceOf</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1008,6 +1167,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1046,6 +1206,8 @@ <secondary>IsOfType</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>IsOfType</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>IsOfType</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1058,6 +1220,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1096,6 +1259,8 @@ <secondary>IsMethod</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>IsMethod</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>IsMethod</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1108,6 +1273,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1142,6 +1308,8 @@ <secondary>IsRoutine</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>IsRoutine</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>IsRoutine</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1154,6 +1322,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1184,6 +1353,14 @@ <indexterm><primary>Language Level</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> <secondary>LanguageLevel</secondary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>LanguageLevel</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>LanguageLevel</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>LanguageLevel</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>LanguageLevel</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1196,6 +1373,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Tes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>Yes</entry></row> </tbody> </tgroup> @@ -1225,6 +1403,8 @@ <secondary>LoadPackage</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>LoadPackage</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>LoadPackage</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1237,6 +1417,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1271,6 +1452,8 @@ <secondary>LoadPackageFromData</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>LoadPackageFromData</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>LoadPackageFromData</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1283,6 +1466,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1324,6 +1508,8 @@ <secondary>NewMethod</secondary></indexterm> <indexterm><primary>Method context methods</primary> <secondary>NewMethod</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>NewMethod</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1336,6 +1522,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1377,6 +1564,8 @@ <secondary>NewRoutine</secondary></indexterm> <indexterm><primary>Method context methods</primary> <secondary>NewRoutine</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>NewRoutine</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1389,6 +1578,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1430,6 +1620,8 @@ <secondary>ObjectToCSelf</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>ObjectToCSelf</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToCSelf</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1442,6 +1634,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1476,6 +1669,8 @@ <secondary>ReleaseGlobalReference</secondary></indexterm> <indexterm><primary>Method context methods</primary> <secondary>ReleaseGlobalReference</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ReleaseGlobalReference</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1488,6 +1683,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1521,6 +1717,8 @@ <secondary>ReleaseLocalReference</secondary></indexterm> <indexterm><primary>Method context methods</primary> <secondary>ReleaseLocalReference</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ReleaseLocalReference</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1533,6 +1731,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1566,6 +1765,8 @@ <secondary>RequestGlobalReference</secondary></indexterm> <indexterm><primary>Method context methods</primary> <secondary>RequestGlobalReference</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>RequestGlobalReference</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1578,6 +1779,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1611,6 +1813,8 @@ <secondary>SendMessage</secondary></indexterm> <indexterm><primary>Method context methods</primary> <secondary>SendMessage</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>SendMessage</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1623,6 +1827,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1663,6 +1868,8 @@ <secondary>SendMessage0</secondary></indexterm> <indexterm><primary>Method context methods</primary> <secondary>SendMessage0</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>SendMessage0</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1675,6 +1882,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1712,6 +1920,8 @@ <secondary>SendMessage1</secondary></indexterm> <indexterm><primary>Method context methods</primary> <secondary>SendMessage1</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>SendMessage1</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1724,6 +1934,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1764,6 +1975,8 @@ <secondary>SendMessage2</secondary></indexterm> <indexterm><primary>Method context methods</primary> <secondary>SendMessage2</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>SendMessage2</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1776,6 +1989,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1827,6 +2041,7 @@ <row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>No</entry></row> <row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> <row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> @@ -1868,6 +2083,7 @@ <row><entry>Thread</entry><entry>No</entry></row> <row><entry>Method</entry><entry>No</entry></row> <row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> <row><entry>Interpreter</entry><entry>Yes</entry></row> </tbody> </tgroup> @@ -1909,6 +2125,7 @@ <row><entry>Thread</entry><entry>No</entry></row> <row><entry>Method</entry><entry>No</entry></row> <row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> <row><entry>Interpreter</entry><entry>Yes</entry></row> </tbody> </tgroup> @@ -1929,11 +2146,303 @@ </section> </section> +<section id="mthUintptr"><title>Uintptr</title> +<indexterm><primary>Uintptr</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>Uintptr</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>Uintptr</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>Uintptr</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>Uintptr</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +uintptr_t n; +>>--obj = context->Uintptr(n);------------------------------------------->< +]]> +</programlisting> +<para>Convert a C unsigned integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +Alias of the <link linkend="mthUintptrToObject">UintptrToObject</link> method. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the unsigned interger to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C unsigned integer.</para> +</section> +</section> +<section id="mthUintptrToObject"><title>UintptrToObject</title> +<indexterm><primary>UintptrToObject</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>UintptrToObject</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>UintptrToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>UintptrToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>UintptrToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +uintptr_t n; +>>--obj = context->UintptrToObject(n);----------------------------------->< +]]> +</programlisting> +<para>Convert a C unsigned integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the unsigned interger to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C unsigned integer.</para> +</section> +</section> +<section id="mthValuesToObject"><title>ValuesToObject</title> +<indexterm><primary>ValuesToObject</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ValuesToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ValuesToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ValuesToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObj obj; +ValueDescriptor desc[3]; +>>--obj = context->ValuesToObject(desc);--------------------------------->< +]]> +</programlisting> +<para>Convert a Rexx ValueDescriptor struct array to a Rexx array object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">desc</emphasis></term> + <listitem><para>A C pointer to the ValueDescriptor struct array to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx array object that contains the converted C ValueDescriptors.</para> +</section> +</section> +<section id="mthValueToObject"><title>ValueToObject</title> +<indexterm><primary>ValueToObject</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ValueToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ValueToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ValueToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +ValueDescriptor desc;; + +>>--obj = context->ValueToObject(&desc);--------------------------------->< +]]> +</programlisting> +<para>Convert a Rexx valueDescriptor struct to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">desc</emphasis></term> + <listitem><para>A C pointer to the ValueDescriptor struct to be converted.</para></listitem> + </varlistentry> +</variablelist> </section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C ValueDescriptor.</para> +</section> +</section> + +<section id="mthWholeNumber"><title>WholeNumber</title> +<indexterm><primary>WholeNumber</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>WholeNumber</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>WholeNumber</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>WholeNumber</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>WholeNumber</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +wholenumber_t n; + +>>--obj = context->WholeNumber(n);--------------------------------------->< +]]> +</programlisting> +<para>Convert a C signed integer to a Rexx object. +Alias of the <link linkend="mthWholeNumberToObject">WholeNumberToObject</link> method. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C whole number to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C whole number.</para> +</section> +</section> + +<section id="mthWholeNumberToObject"><title>WholeNumberToObject</title> +<indexterm><primary>WholeNumberToObject</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>WholeNumberToObject</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>WholeNumberToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>WholeNumberToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>WholeNumberToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +wholenumber_t n; + +>>--obj = context->WholeNumberToObject(n);------------------------------->< +]]> +</programlisting> +<para>Convert a C signed integer to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C whole number to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C whole number.</para> +</section> +</section> + + + + + + + +</section> </chapter> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-06 16:23:10
|
Revision: 3878 http://oorexx.svn.sourceforge.net/oorexx/?rev=3878&view=rev Author: wdashley Date: 2009-01-06 16:23:09 +0000 (Tue, 06 Jan 2009) Log Message: ----------- More oo api docs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-06 16:02:11 UTC (rev 3877) +++ docs/trunk/rexxpg/api.sgml 2009-01-06 16:23:09 UTC (rev 3878) @@ -1661,6 +1661,57 @@ </section> </section> +<section id="mthObjectToValue"><title>ObjectToValue</title> +<indexterm><primary>ObjectToValue</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToValue</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToValue</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToValue</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +ValueDescriptor desc;; +logical_t flag; + +>>--flag = context->ObjectToValue(obj, &desc);--------------------------->< +]]> +</programlisting> +<para>Convert a Rexx object to a ValueDescriptor struct. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to be converted.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">desc</emphasis></term> + <listitem><para>A C pointer to a ValueDescriptor struct to receive the converted data.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error.</para> +</section> +</section> + <section id="mthReleaseGlobalReference"><title>ReleaseGlobalReference</title> <indexterm><primary>ReleaseGlobalReference</primary></indexterm> <indexterm><primary>Thread context methods</primary> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-06 22:12:17
|
Revision: 3882 http://oorexx.svn.sourceforge.net/oorexx/?rev=3882&view=rev Author: wdashley Date: 2009-01-06 22:12:14 +0000 (Tue, 06 Jan 2009) Log Message: ----------- More oo api docs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-06 20:17:58 UTC (rev 3881) +++ docs/trunk/rexxpg/api.sgml 2009-01-06 22:12:14 UTC (rev 3882) @@ -1689,7 +1689,7 @@ <programlisting> <![CDATA[ RexxObjectPtr obj; -ValueDescriptor desc;; +ValueDescriptor desc; logical_t flag; >>--flag = context->ObjectToValue(obj, &desc);--------------------------->< @@ -1712,6 +1712,57 @@ </section> </section> +<section id="mthObjectToWholeNumber"><title>ObjectToWholeNumber</title> +<indexterm><primary>ObjectToWholeNumber</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToWholeNumber</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToWholeNumber</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToWholeNumber</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +wholenumber_t wn; +logical_t flag; + +>>--flag = context->ObjectToWholeNumber(obj, &wn);----------------------->< +]]> +</programlisting> +<para>Convert a whole number into a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The target Rexx object for the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">wn</emphasis></term> + <listitem><para>A C pointer to a wholenumber_t to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error.</para> +</section> +</section> + <section id="mthReleaseGlobalReference"><title>ReleaseGlobalReference</title> <indexterm><primary>ReleaseGlobalReference</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -2118,6 +2169,105 @@ </section> </section> +<section id="mthStringSize"><title>StringSize</title> +<indexterm><primary>StringSize</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>StringSize</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>StringSize</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>StringSize</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>StringSize</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +size_t sz; + +>>--obj = context->StringSize(sz);--------------------------------------->< +]]> +</programlisting> +<para>Convert a C size_t integer to a Rexx object. +Alias of the <link linkend="mthStringSizeToObject">StringSizeToObject</link> method. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The size_t value to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C size_t integer.</para> +</section> +</section> + +<section id="mthStringSizeToObject"><title>StringSizeToObject</title> +<indexterm><primary>StringSizeToObject</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>StringSizeToObject</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>StringSizeToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>StringSizeToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>StringSizeToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +size_t sz; + +>>--obj = context->StringSizeToObject(sz);------------------------------->< +]]> +</programlisting> +<para>Convert a C size_t integer to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The size_t value to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C size_t integer.</para> +</section> +</section> + <section id="mthSetTrace"><title>SetTrace</title> <indexterm><primary>SetTrace</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> @@ -2417,12 +2567,16 @@ </tbody> </tgroup> </informaltable> +<para>There are two forms of this method.</para> <programlisting> <![CDATA[ RexxObjectPtr obj; wholenumber_t n; +logical_t flag; >>--obj = context->WholeNumber(n);--------------------------------------->< + +>>--flag = context->WholeNumber(obj, n);--------------------------------->< ]]> </programlisting> <para>Convert a C signed integer to a Rexx object. @@ -2433,10 +2587,15 @@ <varlistentry><term><emphasis role="italic">n</emphasis></term> <listitem><para>The C whole number to be converted.</para></listitem> </varlistentry> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The target Rexx object of the conversion.</para></listitem> + </varlistentry> </variablelist> </section> <section><title>Returns</title> -<para>A pointer to the Rexx object that represents the C whole number.</para> +<para>A pointer to the Rexx object that represents the C whole number or +0 = success, 1 = conversion error. +</para> </section> </section> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-12 16:14:30
|
Revision: 3910 http://oorexx.svn.sourceforge.net/oorexx/?rev=3910&view=rev Author: wdashley Date: 2009-01-12 16:14:24 +0000 (Mon, 12 Jan 2009) Log Message: ----------- More oo api docs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-11 22:30:08 UTC (rev 3909) +++ docs/trunk/rexxpg/api.sgml 2009-01-12 16:14:24 UTC (rev 3910) @@ -1000,6 +1000,114 @@ </section> </section> +<section id="mthInt64"><title>Int64</title> +<indexterm><primary>Int64</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>Int64</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>Int64</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>Int64</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>Int64</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<para>There a two forms of this method.</para> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; +int64_t n; + +>>--obj = context->Int64(n);--------------------------------------------->< + +>>--logical_t = context->Int64(obj, &n);--------------------------------->< +]]> +</programlisting> +<para>There a two forms of this method. +The first converts a C 64 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +The second converts a Rexx object to a C 64 bit integer pointer to by <emphasis role="italic">n</emphasis>. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the interger to be converted or the target of the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C integer in the first forms. +The second for returns 0 = success, 1 = failure.</para> +</section> +</section> + +<section id="mthInt64ToObject"><title>Int64ToObject</title> +<indexterm><primary>Int64ToObject</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>Int64ToObject</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>Int64ToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>Int64ToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>Int64ToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +int64_t n; + +>>--obj = context->Int64ToObject(n);------------------------------------->< +]]> +</programlisting> +<para>Convert a C 64 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the interger to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C integer.</para> +</section> +</section> + <section id="mthInterpreterVersion"><title>InterpreterVersion</title> <indexterm><primary>InterpreterVersion</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1198,16 +1306,16 @@ </section> </section> -<section id="mthIsOfType"><title>IsOfType</title> -<indexterm><primary>IsOfType</primary></indexterm> +<section id="mthIsMethod"><title>IsMethod</title> +<indexterm><primary>IsMethod</primary></indexterm> <indexterm><primary>Thread context methods</primary> -<secondary>IsOfType</secondary></indexterm> +<secondary>IsMethod</secondary></indexterm> <indexterm><primary>Method context methods</primary> -<secondary>IsOfType</secondary></indexterm> +<secondary>IsMethod</secondary></indexterm> <indexterm><primary>Function context methods</primary> -<secondary>IsOfType</secondary></indexterm> +<secondary>IsMethod</secondary></indexterm> <indexterm><primary>Exit context methods</primary> -<secondary>IsOfType</secondary></indexterm> +<secondary>IsMethod</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1228,39 +1336,35 @@ <programlisting> <![CDATA[ RexxObjectPtr obj; -CSTRING class; logical_t flag; ->>--flag = context->IsOfType(obj, class);------------------------------->< +>>--flag = context->IsMethod(obj);-------------------------------------->< ]]> </programlisting> -<para>Tests an object to see if is an instance of or an instance of a subclass of the specified class. +<para>Tests an object to see if is a RexxMethodObject. </para> <section><title>Arguments</title> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> </varlistentry> - <varlistentry><term><emphasis role="italic">class</emphasis></term> - <listitem><para>An ASCIIZ string containing the name of the Rexx class. This string will automatically be converted to upper case.</para></listitem> - </varlistentry> </variablelist> </section> <section><title>Returns</title> -<para>1 = is a member, 0 = not a member.</para> +<para>1 = is a method, 0 = not a method.</para> </section> </section> -<section id="mthIsMethod"><title>IsMethod</title> -<indexterm><primary>IsMethod</primary></indexterm> +<section id="mthIsOfType"><title>IsOfType</title> +<indexterm><primary>IsOfType</primary></indexterm> <indexterm><primary>Thread context methods</primary> -<secondary>IsMethod</secondary></indexterm> +<secondary>IsOfType</secondary></indexterm> <indexterm><primary>Method context methods</primary> -<secondary>IsMethod</secondary></indexterm> +<secondary>IsOfType</secondary></indexterm> <indexterm><primary>Function context methods</primary> -<secondary>IsMethod</secondary></indexterm> +<secondary>IsOfType</secondary></indexterm> <indexterm><primary>Exit context methods</primary> -<secondary>IsMethod</secondary></indexterm> +<secondary>IsOfType</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -1281,22 +1385,26 @@ <programlisting> <![CDATA[ RexxObjectPtr obj; +CSTRING class; logical_t flag; ->>--flag = context->IsMethod(obj);-------------------------------------->< +>>--flag = context->IsOfType(obj, class);------------------------------->< ]]> </programlisting> -<para>Tests an object to see if is a RexxMethodObject. +<para>Tests an object to see if is an instance of or an instance of a subclass of the specified class. </para> <section><title>Arguments</title> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> </varlistentry> + <varlistentry><term><emphasis role="italic">class</emphasis></term> + <listitem><para>An ASCIIZ string containing the name of the Rexx class. This string will automatically be converted to upper case.</para></listitem> + </varlistentry> </variablelist> </section> <section><title>Returns</title> -<para>1 = is a method, 0 = not a method.</para> +<para>1 = is a member, 0 = not a member.</para> </section> </section> @@ -1661,6 +1769,159 @@ </section> </section> +<section id="mthObjectToInt64"><title>ObjectToInt64</title> +<indexterm><primary>ObjectToInt64</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToInt64</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToInt64</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToInt64</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +int64_t n; +logical_t flag; + +>>--flag = context->ObjectToInt64(obj, &n);------------------------------>< +]]> +</programlisting> +<para>Convert a 64 bit integer into a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The target Rexx object for the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>A C pointer to a int64_t to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error.</para> +</section> +</section> + +<section id="mthObjectToStringSize"><title>ObjectToStringSize</title> +<indexterm><primary>ObjectToStringSize</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToStringSize</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToStringSize</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToStringSize</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +size_t n; +logical_t flag; + +>>--flag = context->ObjectToStringSize(obj, &n);------------------------->< +]]> +</programlisting> +<para>Convert a string size number into a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The target Rexx object for the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>A C pointer to a size_t to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error.</para> +</section> +</section> + +<section id="mthObjectToUnsignedInt64"><title>ObjectToUnsignedInt64</title> +<indexterm><primary>ObjectToUnsignedInt64</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToUnsignedInt64</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToUnsignedInt64</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToUnsignedInt64</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +uint64_t n; +logical_t flag; + +>>--flag = context->ObjectToUnsignedInt64(obj, &n);---------------------->< +]]> +</programlisting> +<para>Convert an unsigned 64 bit integer into a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The target Rexx object for the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>A C pointer to a uint64_t to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error.</para> +</section> +</section> + <section id="mthObjectToValue"><title>ObjectToValue</title> <indexterm><primary>ObjectToValue</primary></indexterm> <indexterm><primary>Function context methods</primary> @@ -2219,16 +2480,10 @@ </section> </section> -<section id="mthStringSizeToObject"><title>StringSizeToObject</title> -<indexterm><primary>StringSizeToObject</primary></indexterm> -<indexterm><primary>Thread context methods</primary> -<secondary>StringSizeToObject</secondary></indexterm> -<indexterm><primary>Function context methods</primary> -<secondary>StringSizeToObject</secondary></indexterm> -<indexterm><primary>Method context methods</primary> -<secondary>StringSizeToObject</secondary></indexterm> -<indexterm><primary>Exit context methods</primary> -<secondary>StringSizeToObject</secondary></indexterm> +<section id="mthSetTrace"><title>SetTrace</title> +<indexterm><primary>SetTrace</primary></indexterm> +<indexterm><primary>Rexx instance context methods</primary> +<secondary>SetTrace</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -2238,40 +2493,45 @@ <entry><emphasis role="bold">Context</emphasis></entry> <entry><emphasis role="bold">Available</emphasis></entry> </row> -<row><entry>Thread</entry><entry>Yes</entry></row> -<row><entry>Method</entry><entry>Yes</entry></row> -<row><entry>Function</entry><entry>Yes</entry></row> -<row><entry>Exit</entry><entry>Yes</entry></row> -<row><entry>Interpreter</entry><entry>No</entry></row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>Yes</entry></row> </tbody> </tgroup> </informaltable> <programlisting> <![CDATA[ -RexxObjectPtr obj; -size_t sz; +logical_t flag; ->>--obj = context->StringSizeToObject(sz);------------------------------->< +>>--context->SetTrace(flag);--------------------------------------------->< ]]> </programlisting> -<para>Convert a C size_t integer to a Rexx object. +<para>Sets the trace flag of the interpreter. </para> <section><title>Arguments</title> <variablelist> - <varlistentry><term><emphasis role="italic">n</emphasis></term> - <listitem><para>The size_t value to be converted.</para></listitem> + <varlistentry><term><emphasis role="italic">flag</emphasis></term> + <listitem><para>Logical boolean flag.</para></listitem> </varlistentry> </variablelist> </section> <section><title>Returns</title> -<para>A pointer to the Rexx object that represents the C size_t integer.</para> +<para>Void.</para> </section> </section> -<section id="mthSetTrace"><title>SetTrace</title> -<indexterm><primary>SetTrace</primary></indexterm> -<indexterm><primary>Rexx instance context methods</primary> -<secondary>SetTrace</secondary></indexterm> +<section id="mthStringSizeToObject"><title>StringSizeToObject</title> +<indexterm><primary>StringSizeToObject</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>StringSizeToObject</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>StringSizeToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>StringSizeToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>StringSizeToObject</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -2281,32 +2541,33 @@ <entry><emphasis role="bold">Context</emphasis></entry> <entry><emphasis role="bold">Available</emphasis></entry> </row> -<row><entry>Thread</entry><entry>No</entry></row> -<row><entry>Method</entry><entry>No</entry></row> -<row><entry>Function</entry><entry>No</entry></row> -<row><entry>Exit</entry><entry>No</entry></row> -<row><entry>Interpreter</entry><entry>Yes</entry></row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> </informaltable> <programlisting> <![CDATA[ -logical_t flag; +RexxObjectPtr obj; +size_t sz; ->>--context->SetTrace(flag);--------------------------------------------->< +>>--obj = context->StringSizeToObject(sz);------------------------------->< ]]> </programlisting> -<para>Sets the trace flag of the interpreter. +<para>Convert a C size_t integer to a Rexx object. </para> <section><title>Arguments</title> <variablelist> - <varlistentry><term><emphasis role="italic">flag</emphasis></term> - <listitem><para>Logical boolean flag.</para></listitem> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The size_t value to be converted.</para></listitem> </varlistentry> </variablelist> </section> <section><title>Returns</title> -<para>Void.</para> +<para>A pointer to the Rexx object that represents the C size_t integer.</para> </section> </section> @@ -2446,6 +2707,114 @@ </section> </section> +<section id="mthUnsignedInt64"><title>UnsignedInt64</title> +<indexterm><primary>UnsignedInt64</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>UnsignedInt64</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>UnsignedInt64</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>UnsignedInt64</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>UnsignedInt64</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; +uint64_t n; + +>>--obj = context->UnsignedInt64(n);------------------------------------->< + +>>--flag = context->UnsignedInt64(obj, &n);------------------------------>< +]]> +</programlisting> +<para>There are two forms of this method. +The first convert a C 64 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. +The second converts a Rexx object a C 64 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis>. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the unsigned interger to be converted.for the first form of the method. + For the second form this is the target of the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the unsigned interger to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C unsigned integer for the first form +and for the seconf form 0 = success, 1 = failure.</para> +</section> +</section> + +<section id="mthUnsignedInt64ToObject"><title>UnsignedInt64ToObject</title> +<indexterm><primary>UnsignedInt64ToObject</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>UnsignedInt64ToObject</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>UnsignedInt64ToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>UnsignedInt64ToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>UnsignedInt64ToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +uint64_t n; + +>>--obj = context->UnsignedInt64ToObject(n);----------------------------->< +]]> +</programlisting> +<para>Convert a C 64 bit unsigned integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the unsigned interger to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C unsigned integer.</para> +</section> +</section> + <section id="mthValuesToObject"><title>ValuesToObject</title> <indexterm><primary>ValuesToObject</primary></indexterm> <indexterm><primary>Function context methods</primary> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-12 17:34:59
|
Revision: 3911 http://oorexx.svn.sourceforge.net/oorexx/?rev=3911&view=rev Author: wdashley Date: 2009-01-12 17:34:54 +0000 (Mon, 12 Jan 2009) Log Message: ----------- More oo api docs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-12 16:14:24 UTC (rev 3910) +++ docs/trunk/rexxpg/api.sgml 2009-01-12 17:34:54 UTC (rev 3911) @@ -1000,6 +1000,114 @@ </section> </section> +<section id="mthInt32"><title>Int32</title> +<indexterm><primary>Int32</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>Int32</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>Int32</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>Int32</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>Int32</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<para>There a two forms of this method.</para> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; +int32_t n; + +>>--obj = context->Int32(n);--------------------------------------------->< + +>>--logical_t = context->Int32(obj, &n);--------------------------------->< +]]> +</programlisting> +<para>There a two forms of this method. +The first converts a C 32 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +The second converts a Rexx object to a C 32 bit integer pointer to by <emphasis role="italic">n</emphasis>. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the interger to be converted or the target of the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C integer in the first forms. +The second for returns 0 = success, 1 = failure.</para> +</section> +</section> + +<section id="mthInt32ToObject"><title>Int32ToObject</title> +<indexterm><primary>Int32ToObject</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>Int32ToObject</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>Int32ToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>Int32ToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>Int32ToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +int32_t n; + +>>--obj = context->Int32ToObject(n);------------------------------------->< +]]> +</programlisting> +<para>Convert a C 32 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the interger to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C integer.</para> +</section> +</section> + <section id="mthInt64"><title>Int64</title> <indexterm><primary>Int64</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1769,6 +1877,57 @@ </section> </section> +<section id="mthObjectToInt32"><title>ObjectToInt32</title> +<indexterm><primary>ObjectToInt32</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToInt32</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToInt32</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToInt32</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +int32_t n; +logical_t flag; + +>>--flag = context->ObjectToInt32(obj, &n);------------------------------>< +]]> +</programlisting> +<para>Convert a 32 bit integer into a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The target Rexx object for the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>A C pointer to a int64_t to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error.</para> +</section> +</section> + <section id="mthObjectToInt64"><title>ObjectToInt64</title> <indexterm><primary>ObjectToInt64</primary></indexterm> <indexterm><primary>Function context methods</primary> @@ -1871,6 +2030,57 @@ </section> </section> +<section id="mthObjectToUnsignedInt32"><title>ObjectToUnsignedInt32</title> +<indexterm><primary>ObjectToUnsignedInt32</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToUnsignedInt32</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToUnsignedInt32</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToUnsignedInt32</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +uint32_t n; +logical_t flag; + +>>--flag = context->ObjectToUnsignedInt32(obj, &n);---------------------->< +]]> +</programlisting> +<para>Convert an unsigned 32 bit integer into a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The target Rexx object for the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>A C pointer to a uint32_t to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error.</para> +</section> +</section> + <section id="mthObjectToUnsignedInt64"><title>ObjectToUnsignedInt64</title> <indexterm><primary>ObjectToUnsignedInt64</primary></indexterm> <indexterm><primary>Function context methods</primary> @@ -2707,6 +2917,114 @@ </section> </section> +<section id="mthUnsignedInt32"><title>UnsignedInt32</title> +<indexterm><primary>UnsignedInt32</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>UnsignedInt32</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>UnsignedInt32</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>UnsignedInt32</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>UnsignedInt32</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; +uint32_t n; + +>>--obj = context->UnsignedInt32(n);------------------------------------->< + +>>--flag = context->UnsignedInt32(obj, &n);------------------------------>< +]]> +</programlisting> +<para>There are two forms of this method. +The first convert a C 32 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. +The second converts a Rexx object a C 32 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis>. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the unsigned interger to be converted.for the first form of the method. + For the second form this is the target of the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the unsigned interger to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C unsigned integer for the first form +and for the seconf form 0 = success, 1 = failure.</para> +</section> +</section> + +<section id="mthUnsignedInt32ToObject"><title>UnsignedInt32ToObject</title> +<indexterm><primary>UnsignedInt32ToObject</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>UnsignedInt32ToObject</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>UnsignedInt32ToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>UnsignedInt32ToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>UnsignedInt32ToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +uint32_t n; + +>>--obj = context->UnsignedInt32ToObject(n);----------------------------->< +]]> +</programlisting> +<para>Convert a C 32 bit unsigned integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The C pointer to the unsigned interger to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the Rexx object that represents the C unsigned integer.</para> +</section> +</section> + <section id="mthUnsignedInt64"><title>UnsignedInt64</title> <indexterm><primary>UnsignedInt64</primary></indexterm> <indexterm><primary>Thread context methods</primary> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-12 20:45:57
|
Revision: 3912 http://oorexx.svn.sourceforge.net/oorexx/?rev=3912&view=rev Author: wdashley Date: 2009-01-12 20:45:49 +0000 (Mon, 12 Jan 2009) Log Message: ----------- More oo api docs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-12 17:34:54 UTC (rev 3911) +++ docs/trunk/rexxpg/api.sgml 2009-01-12 20:45:49 UTC (rev 3912) @@ -1027,7 +1027,6 @@ </tbody> </tgroup> </informaltable> -<para>There a two forms of this method.</para> <programlisting> <![CDATA[ RexxObjectPtr obj; @@ -1135,7 +1134,6 @@ </tbody> </tgroup> </informaltable> -<para>There a two forms of this method.</para> <programlisting> <![CDATA[ RexxObjectPtr obj; @@ -1292,19 +1290,27 @@ <programlisting> <![CDATA[ RexxObjectPtr obj; +logical_t flag; intptr_t n; ->>--obj = context->Intptr(n);-------------------------------------------->< +>>--obj = context->Intptr(&n);------------------------------------------->< + +>>--flag = context->Intptr(obj, &n);------------------------------------->< ]]> </programlisting> -<para>Convert a C signed integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. -Alias of the <link linkend="mthIntptrToObject">IntptrToObject</link> method. +<para>There are two formes of this method. +The first converts a C signed integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. +The second converts aRexx object to a C signed integer pointed to by <emphasis role="italic">n</emphasis>. </para> <section><title>Arguments</title> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> - <listitem><para>The C pointer to the signed interger to be converted.</para></listitem> + <listitem><para>The C pointer to the signed interger to be converted in the first form. + The target of the conversion in the second form.</para></listitem> </varlistentry> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to be converted.</para></listitem> + </varlistentry> </variablelist> </section> <section><title>Returns</title> @@ -1344,10 +1350,10 @@ RexxObjectPtr obj; intptr_t n; ->>--obj = context->IntptrToObject(n);------------------------------------>< +>>--obj = context->IntptrToObject(&n);----------------------------------->< ]]> </programlisting> -<para>Convert a C signed integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +<para>Convert a C signed integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. </para> <section><title>Arguments</title> <variablelist> @@ -1879,6 +1885,8 @@ <section id="mthObjectToInt32"><title>ObjectToInt32</title> <indexterm><primary>ObjectToInt32</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToInt32</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>ObjectToInt32</secondary></indexterm> <indexterm><primary>Method context methods</primary> @@ -1930,6 +1938,8 @@ <section id="mthObjectToInt64"><title>ObjectToInt64</title> <indexterm><primary>ObjectToInt64</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToInt64</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>ObjectToInt64</secondary></indexterm> <indexterm><primary>Method context methods</primary> @@ -1979,8 +1989,63 @@ </section> </section> +<section id="mthObjectToIntptr"><title>ObjectToIntptr</title> +<indexterm><primary>ObjectToIntptr</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToIntptr</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToIntptr</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToIntptr</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToIntptr</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +intptr_t n; +logical_t flag; + +>>--flag = context->ObjectToIntptr(obj, &n);----------------------------->< +]]> +</programlisting> +<para>Convert an integer into a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The target Rexx object for the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>A C pointer to a intptr_t to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error.</para> +</section> +</section> + <section id="mthObjectToStringSize"><title>ObjectToStringSize</title> <indexterm><primary>ObjectToStringSize</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToStringSize</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>ObjectToStringSize</secondary></indexterm> <indexterm><primary>Method context methods</primary> @@ -2030,8 +2095,63 @@ </section> </section> +<section id="mthObjectToUintptr"><title>ObjectToUintptr</title> +<indexterm><primary>ObjectToUintptr</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToUintptr</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToUintptr</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToUintptr</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToUintptr</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +uintptr_t n; +logical_t flag; + +>>--flag = context->ObjectToUintptr(obj, &n);---------------------------->< +]]> +</programlisting> +<para>Convert an unsigned integer into a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The target Rexx object for the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>A C pointer to a uintptr_t to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error.</para> +</section> +</section> + <section id="mthObjectToUnsignedInt32"><title>ObjectToUnsignedInt32</title> <indexterm><primary>ObjectToUnsignedInt32</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToUnsignedInt32</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>ObjectToUnsignedInt32</secondary></indexterm> <indexterm><primary>Method context methods</primary> @@ -2083,6 +2203,8 @@ <section id="mthObjectToUnsignedInt64"><title>ObjectToUnsignedInt64</title> <indexterm><primary>ObjectToUnsignedInt64</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToUnsignedInt64</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>ObjectToUnsignedInt64</secondary></indexterm> <indexterm><primary>Method context methods</primary> @@ -2185,6 +2307,8 @@ <section id="mthObjectToWholeNumber"><title>ObjectToWholeNumber</title> <indexterm><primary>ObjectToWholeNumber</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToWholeNumber</secondary></indexterm> <indexterm><primary>Function context methods</primary> <secondary>ObjectToWholeNumber</secondary></indexterm> <indexterm><primary>Method context methods</primary> @@ -2848,23 +2972,32 @@ <programlisting> <![CDATA[ RexxObjectPtr obj; +logical_t flag; uintptr_t n; ->>--obj = context->Uintptr(n);------------------------------------------->< +>>--obj = context->Uintptr(&n);------------------------------------------>< + +>>--flag = context->Uintptr(obj, &n);------------------------------------>< ]]> </programlisting> -<para>Convert a C unsigned integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. -Alias of the <link linkend="mthUintptrToObject">UintptrToObject</link> method. +<para>There are two forms of this method. +The first converts a C unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. +The second converts a Rexx object into a C unsigned integer pointed to by <emphasis role="italic">n</emphasis>. </para> <section><title>Arguments</title> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> - <listitem><para>The C pointer to the unsigned interger to be converted.</para></listitem> + <listitem><para>The C pointer to the unsigned interger to be converted in the first form or + the target of the conversion in the second form of the method.</para></listitem> </varlistentry> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to be converted.</para></listitem> + </varlistentry> </variablelist> </section> <section><title>Returns</title> -<para>A pointer to the Rexx object that represents the C unsigned integer.</para> +<para>A pointer to the Rexx object that represents the C unsigned integer in the first form +or 0 = success, 1 = failure in the second form.</para> </section> </section> @@ -2900,10 +3033,10 @@ RexxObjectPtr obj; uintptr_t n; ->>--obj = context->UintptrToObject(n);----------------------------------->< +>>--obj = context->UintptrToObject(&n);---------------------------------->< ]]> </programlisting> -<para>Convert a C unsigned integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +<para>Convert a C unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. </para> <section><title>Arguments</title> <variablelist> @@ -3254,7 +3387,6 @@ </tbody> </tgroup> </informaltable> -<para>There are two forms of this method.</para> <programlisting> <![CDATA[ RexxObjectPtr obj; @@ -3263,11 +3395,12 @@ >>--obj = context->WholeNumber(n);--------------------------------------->< ->>--flag = context->WholeNumber(obj, n);--------------------------------->< +>>--flag = context->WholeNumber(obj, &n);-------------------------------->< ]]> </programlisting> -<para>Convert a C signed integer to a Rexx object. -Alias of the <link linkend="mthWholeNumberToObject">WholeNumberToObject</link> method. +<para>There are two forms of this method. +The first form converts a C signed integer to a Rexx object. +The second form converts a a Rexx object to a C signed integer. </para> <section><title>Arguments</title> <variablelist> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-13 17:46:29
|
Revision: 3915 http://oorexx.svn.sourceforge.net/oorexx/?rev=3915&view=rev Author: wdashley Date: 2009-01-13 17:46:21 +0000 (Tue, 13 Jan 2009) Log Message: ----------- More oo api docs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-13 17:30:28 UTC (rev 3914) +++ docs/trunk/rexxpg/api.sgml 2009-01-13 17:46:21 UTC (rev 3915) @@ -262,6 +262,64 @@ </section> </section> +<section id="mthCString"><title>CString</title> +<indexterm><primary>CString</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>CString</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>CString</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>CString</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>CString</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +RexxStringObject ostr; +CSTRING str; + +>>--str = context->CString(obj);----------------------------------------->< + +>>--ostr = context->CString(str);---------------------------------------->< +]]> +</programlisting> +<para>There are two forms of this method. +The first converts a Rexx object into a C ASCIIZ string. +The second converts C ASCIIZ string into a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object for the conversion for the first form of the method.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The source C ASCII string for the conversion for the second form of the method.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Returns an C ASCII string for the first form of the method. +Returns a Rexx object for the second form of the method.</para> +</section> +</section> + <section id="mthDetachThread"><title>DetachThread</title> <indexterm><primary>DetachThread</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -299,6 +357,167 @@ </section> </section> +<section id="mthDouble"><title>Double</title> +<indexterm><primary>Double</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>Double</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>Double</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>Double</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>Double</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +double n; +logical_t flag; + +>>--obj = context->Double(n);-------------------------------------------->< + +>>--flag = context->Double(obj, &n);------------------------------------->< +]]> +</programlisting> +<para>There are two forms of this method. +The first form converts C double value to a Rexx object. +The second form converts a Rexx object to a C double value. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The double value to be converted in the first form of the method. + The target of the conversion in the second form of the method.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to be converted..</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Returns a Rexx object with the string value of the double value in the first form of the method. +0 - success, 1 = failure in the second form of the method.</para> +</section> +</section> + +<section id="mthDoubleToObject"><title>DoubleToObject</title> +<indexterm><primary>DoubleToObject</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>DoubleToObject</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>DoubleToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>DoubleToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>DoubleToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +double n; + +>>--obj = context->DoubleToObject(n);------------------------------------>< +]]> +</programlisting> +<para>Converts C double value to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The double value to be converted.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Rexx object with the string value of the double value.</para> +</section> +</section> + +<section id="mthDoubleToObjectWithPrecision"><title>DoubleToObjectWithPrecision</title> +<indexterm><primary>DoubleToObjectWithPrecision</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>DoubleToObjectWithPrecision</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>DoubleToObjectWithPrecision</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>DoubleToObjectWithPrecision</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>DoubleToObjectWithPrecision</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +size_t p; +double n; + +>>--obj = context->DoubleToObject(n, p);--------------------------------->< +]]> +</programlisting> +<para>Converts C double value to a Rexx object with a specific precision. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The double value to be converted.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">p</emphasis></term> + <listitem><para>The precision to be used for the conversion.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Rexx object with the string value of the double value.</para> +</section> +</section> + <section id="mthFindClass"><title>FindClass</title> <indexterm><primary>FindClass</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1722,6 +1941,113 @@ </section> </section> +<section id="mthLogical"><title>Logical</title> +<indexterm><primary>Logical</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>Logical</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>Logical</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>Logical</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>Logical</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag, n; + +>>--flag = context->Logical(obj, &n);------------------------------------>< + +>>--obj = context->Logical(n);------------------------------------------->< +]]> +</programlisting> +<para>This method has two forms. +The first form converts a Rexx object to a C logical value (0 or 1). +The second form converts C logical value to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to be converted in the first form of the method.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>A C pointer to a logical_t to receive the conversion in the first form of the method. + A logical_t that is the source of the conversion in the second form of the method.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error in the first form of the method. In the second form +a Rexx object is returned.</para> +</section> +</section> + +<section id="mthLogicalToObject"><title>LogicalToObject</title> +<indexterm><primary>LogicalToObject</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>LogicalToObject</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>LogicalToObject</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>LogicalToObject</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>LogicalToObject</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag, n; + +>>--obj = context->LogicalToObject(n);----------------------------------->< +]]> +</programlisting> +<para>Converts C logical value to a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The logical_t value to be converted..</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A Rexx object with the string value of 0 or 1 is returned.</para> +</section> +</section> + <section id="mthNewMethod"><title>NewMethod</title> <indexterm><primary>NewMethod</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1834,6 +2160,61 @@ </section> </section> +<section id="mthNewString"><title>NewString</title> +<indexterm><primary>NewString</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>NewString</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>NewString</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>NewString</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>NewString</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxRoutineObject obj; +CSTRING str; +size_t len; + +>>--obj = context->NewString(str, len);---------------------------------->< + +>>--obj = context->NewString(str);--------------------------------------->< +]]> +</programlisting> +<para>There are two forms of this method. Both create a new Rexx object from a C string. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The ASCIIZ string to be converted.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">len</emphasis></term> + <listitem><para>Length of the <emphasis role="italic">str</emphasis> string.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the new Rexx object.</para> +</section> +</section> + <section id="mthObjectToCSelf"><title>ObjectToCSelf</title> <indexterm><primary>ObjectToCSelf</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1883,6 +2264,59 @@ </section> </section> +<section id="mthObjectToDouble"><title>ObjectToDouble</title> +<indexterm><primary>ObjectToDouble</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToDouble</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToDouble</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToDouble</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToDouble</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +double n; +logical_t flag; + +>>--flag = context->ObjectToDouble(obj, &n);----------------------------->< +]]> +</programlisting> +<para>Converts a Rexx object to a C double value. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object for the conversion.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>A C pointer to the double result.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error.</para> +</section> +</section> + <section id="mthObjectToInt32"><title>ObjectToInt32</title> <indexterm><primary>ObjectToInt32</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -2042,6 +2476,107 @@ </section> </section> +<section id="mthObjectToLogical"><title>ObjectToLogical</title> +<indexterm><primary>ObjectToLogical</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToLogical</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToLogical</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToLogical</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToLogical</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag, n; + +>>--flag = context->ObjectToLogical(obj, &n);---------------------------->< +]]> +</programlisting> +<para>Converts a Rexx object to a C logical value (0 or 1). +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to be converted.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>A C pointer to a logical_t to receive the conversion.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>0 = success, 1 = conversion error.</para> +</section> +</section> + +<section id="mthObjectToString"><title>ObjectToString</title> +<indexterm><primary>ObjectToString</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToString</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToString</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToString</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToString</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +RexxStringObject str; + +>>--str = context->ObjectToString(obj);---------------------------------->< +]]> +</programlisting> +<para>Convert a Rexx object to a Rexx string object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object for the conversion.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx string object.</para> +</section> +</section> + <section id="mthObjectToStringSize"><title>ObjectToStringSize</title> <indexterm><primary>ObjectToStringSize</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -2095,6 +2630,55 @@ </section> </section> +<section id="mthObjectToStringValue"><title>ObjectToStringValue</title> +<indexterm><primary>ObjectToStringValue</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ObjectToStringValue</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ObjectToStringValue</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ObjectToStringValue</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ObjectToStringValue</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +CSTRING str; + +>>--str = context->ObjectToStringValue(obj);----------------------------->< +]]> +</programlisting> +<para>Convert a Rexx object to a C ASCOOZ string. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object for the conversion.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The C ASCII string.</para> +</section> +</section> + <section id="mthObjectToUintptr"><title>ObjectToUintptr</title> <indexterm><primary>ObjectToUintptr</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -2271,7 +2855,7 @@ <entry><emphasis role="bold">Context</emphasis></entry> <entry><emphasis role="bold">Available</emphasis></entry> </row> -<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> <row><entry>Exit</entry><entry>Yes</entry></row> @@ -2764,16 +3348,58 @@ </section> </section> -<section id="mthStringSize"><title>StringSize</title> -<indexterm><primary>StringSize</primary></indexterm> +<section id="mthSetTrace"><title>SetTrace</title> +<indexterm><primary>SetTrace</primary></indexterm> +<indexterm><primary>Rexx instance context methods</primary> +<secondary>SetTrace</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>Yes</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +logical_t flag; + +>>--context->SetTrace(flag);--------------------------------------------->< +]]> +</programlisting> +<para>Sets the trace flag of the interpreter. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">flag</emphasis></term> + <listitem><para>Logical boolean flag.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthString"><title>String</title> +<indexterm><primary>String</primary></indexterm> <indexterm><primary>Thread context methods</primary> -<secondary>StringSize</secondary></indexterm> +<secondary>String</secondary></indexterm> <indexterm><primary>Function context methods</primary> -<secondary>StringSize</secondary></indexterm> +<secondary>String</secondary></indexterm> <indexterm><primary>Method context methods</primary> -<secondary>StringSize</secondary></indexterm> +<secondary>String</secondary></indexterm> <indexterm><primary>Exit context methods</primary> -<secondary>StringSize</secondary></indexterm> +<secondary>String</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -2793,31 +3419,202 @@ </informaltable> <programlisting> <![CDATA[ +RexxRoutineObject obj; +CSTRING str; +size_t len; + +>>--obj = context->String(str, len);------------------------------------->< + +>>--obj = context->String(str);------------------------------------------>< +]]> +</programlisting> +<para>There are two forms of this method. Both create a new Rexx object from a C string. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The ASCIIZ string to be converted.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">len</emphasis></term> + <listitem><para>Length of the <emphasis role="italic">str</emphasis> string.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the new Rexx object.</para> +</section> +</section> + +<section id="mthStringData"><title>StringData</title> +<indexterm><primary>StringData</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>StringData</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>StringData</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>StringData</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>StringData</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ RexxObjectPtr obj; +CSTRING str; + +>>--str = context->StringData(obj);-------------------------------------->< +]]> +</programlisting> +<para>Convert a Rexx object into a C ASCIIZ string. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object for the conversion.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The C ASCII string.</para> +</section> +</section> + +<section id="mthStringGet"><title>StringGet</title> +<indexterm><primary>StringGet</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>StringGet</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>StringGet</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>StringGet</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>StringGet</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +POINTER str; +size_t c, len1, len2; + +>>--c = context->StringGet(obj, len1, str, len2);------------------------>< +]]> +</programlisting> +<para>Copies all or part of the Rexx object string value to the C string buffer. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object for the copy.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">len1</emphasis></term> + <listitem><para>The source Rexx object starting position for the copy. + This argument is 1-based</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>A pointer to the target buffer for the copy. Note that the buffer is + NOT zero-terminated.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">len2</emphasis></term> + <listitem><para>The number of characters to copy. This argument should be less than or equal the + size of the <emphasis role="italic">str</emphasis> buffer or a buffer overrun will result.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The number of characters actually copied.</para> +</section> +</section> + +<section id="mthStringLength"><title>StringLength</title> +<indexterm><primary>StringLength</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>StringLength</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>StringLength</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>StringLength</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>StringLength</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; size_t sz; ->>--obj = context->StringSize(sz);--------------------------------------->< +>>--sz = context->StringLength(obj);------------------------------------->< ]]> </programlisting> -<para>Convert a C size_t integer to a Rexx object. -Alias of the <link linkend="mthStringSizeToObject">StringSizeToObject</link> method. +<para>Return the lenght of the string value of a Rexx object. </para> <section><title>Arguments</title> <variablelist> - <varlistentry><term><emphasis role="italic">n</emphasis></term> - <listitem><para>The size_t value to be converted.</para></listitem> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object.</para></listitem> </varlistentry> </variablelist> </section> <section><title>Returns</title> -<para>A pointer to the Rexx object that represents the C size_t integer.</para> +<para>The string length of the Rexx object.</para> </section> </section> -<section id="mthSetTrace"><title>SetTrace</title> -<indexterm><primary>SetTrace</primary></indexterm> -<indexterm><primary>Rexx instance context methods</primary> -<secondary>SetTrace</secondary></indexterm> +<section id="mthStringSize"><title>StringSize</title> +<indexterm><primary>StringSize</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>StringSize</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>StringSize</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>StringSize</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>StringSize</secondary></indexterm> <informaltable frame="all"> <tgroup cols="2"> <colspec colnum="1" colwidth="72pc"> @@ -2827,32 +3624,34 @@ <entry><emphasis role="bold">Context</emphasis></entry> <entry><emphasis role="bold">Available</emphasis></entry> </row> -<row><entry>Thread</entry><entry>No</entry></row> -<row><entry>Method</entry><entry>No</entry></row> -<row><entry>Function</entry><entry>No</entry></row> -<row><entry>Exit</entry><entry>No</entry></row> -<row><entry>Interpreter</entry><entry>Yes</entry></row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> </tbody> </tgroup> </informaltable> <programlisting> <![CDATA[ -logical_t flag; +RexxObjectPtr obj; +size_t sz; ->>--context->SetTrace(flag);--------------------------------------------->< +>>--obj = context->StringSize(sz);--------------------------------------->< ]]> </programlisting> -<para>Sets the trace flag of the interpreter. +<para>Convert a C size_t integer to a Rexx object. +Alias of the <link linkend="mthStringSizeToObject">StringSizeToObject</link> method. </para> <section><title>Arguments</title> <variablelist> - <varlistentry><term><emphasis role="italic">flag</emphasis></term> - <listitem><para>Logical boolean flag.</para></listitem> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The size_t value to be converted.</para></listitem> </varlistentry> </variablelist> </section> <section><title>Returns</title> -<para>Void.</para> +<para>A pointer to the Rexx object that represents the C size_t integer.</para> </section> </section> @@ -3283,7 +4082,7 @@ <entry><emphasis role="bold">Context</emphasis></entry> <entry><emphasis role="bold">Available</emphasis></entry> </row> -<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> <row><entry>Exit</entry><entry>Yes</entry></row> @@ -3330,7 +4129,7 @@ <entry><emphasis role="bold">Context</emphasis></entry> <entry><emphasis role="bold">Available</emphasis></entry> </row> -<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Thread</entry><entry>Yes</entry></row> <row><entry>Method</entry><entry>Yes</entry></row> <row><entry>Function</entry><entry>Yes</entry></row> <row><entry>Exit</entry><entry>Yes</entry></row> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-16 17:02:54
|
Revision: 3929 http://oorexx.svn.sourceforge.net/oorexx/?rev=3929&view=rev Author: wdashley Date: 2009-01-16 17:02:47 +0000 (Fri, 16 Jan 2009) Log Message: ----------- More oo api docs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-16 00:22:15 UTC (rev 3928) +++ docs/trunk/rexxpg/api.sgml 2009-01-16 17:02:47 UTC (rev 3929) @@ -114,6 +114,650 @@ <section id="apilisting"><title>Rexx Methods Listing</title> <para>This section describes each available method and its associated context.</para> +<section id="mthArray"><title>Array</title> +<indexterm><primary>Array</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>Array</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>Array</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>Array</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>Array</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +RexxObjectPtr obj1, obj2, obj3, obj4; + +>>--arr = context->Array(obj1);------------------------------------------>< + +>>--arr = context->Array(obj1, obj2);------------------------------------>< + +>>--arr = context->Array(obj1, obj2, obj3);------------------------------>< + +>>--arr = context->Array(obj1, obj2, obj3, obj4);------------------------>< +]]> +</programlisting> +<para>This method has four forms. +It create a new one-dimension array with the specified objects. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj1</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj2</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj3</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj4</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The new Rexx array object.</para> +</section> +</section> + +<section id="mthArrayAppend"><title>ArrayAppend</title> +<indexterm><primary>ArrayAppend</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ArrayAppend</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ArrayAppend</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ArrayAppend</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ArrayAppend</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +RexxObjectPtr obj; +size_t n; + +>>--n = context->ArrayAppend(arr, obj);---------------------------------->< +]]> +</programlisting> +<para>Append a Rexx object to the end of the Rexx array. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>The source Rexx array object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to be appended.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The number of elements in the Rexx array object.</para> +</section> +</section> + +<section id="mthArrayAppendString"><title>ArrayAppendString</title> +<indexterm><primary>ArrayAppendString</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ArrayAppendString</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ArrayAppendString</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ArrayAppendString</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ArrayAppendString</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +CSTRING str; +size_t n, len; + +>>--n = context->ArrayAppendString(arr, str, len);----------------------->< +]]> +</programlisting> +<para>Append a Rexx object to the end of the Rexx array. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>The source Rexx array object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The CSTRING to be appended.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">len</emphasis></term> + <listitem><para>The length of the CSTRING.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The number of elements in the Rexx array object.</para> +</section> +</section> + +<section id="mthArrayAt"><title>ArrayAt</title> +<indexterm><primary>ArrayAt</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ArrayAt</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ArrayAt</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ArrayAt</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ArrayAt</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +RexxObjectPtr obj; +size_t idx; + +>>--obj = context->ArrayAt(arr, idx);------------------------------------>< +]]> +</programlisting> +<para>Return the object at the specified index. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>The source Rexx array object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">idx</emphasis></term> + <listitem><para>The index into the Rexx array object. This argument is 1-based.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx object at the specified index.</para> +</section> +</section> + +<section id="mthArrayDimension"><title>ArrayDimension</title> +<indexterm><primary>ArrayDimension</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ArrayDimension</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ArrayDimension</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ArrayDimension</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ArrayDimension</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +size_t sz; + +>>--sz = context->ArrayDimension(arr);----------------------------------->< +]]> +</programlisting> +<para>Returns number of dimensions of the Rexx array. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>The source Rexx array object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The number of dimensions of the Rexx array.</para> +</section> +</section> + +<section id="mthArrayItems"><title>ArrayItems</title> +<indexterm><primary>ArrayItems</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ArrayItems</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ArrayItems</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ArrayItems</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ArrayItems</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +size_t sz; + +>>--sz = context->ArrayItems(arr);--------------------------------------->< +]]> +</programlisting> +<para>Returns number of elements in the Rexx array. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>The source Rexx array object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The number of elements in the Rexx array.</para> +</section> +</section> + +<section id="mthArrayOfFour"><title>ArrayOfFour</title> +<indexterm><primary>ArrayOfFour</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ArrayOfFour</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ArrayOfFour</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ArrayOfFour</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ArrayOfFour</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +RexxObjectPtr obj1, obj2, obj3, obj4; + +>>--arr = context->ArrayOfFour(obj1, obj2, obj3, obj4);------------------>< +]]> +</programlisting> +<para>Create a new one-dimension array with the specified objects. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj1</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj2</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj3</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj4</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The new Rexx array object.</para> +</section> +</section> + +<section id="mthArrayOfThree"><title>ArrayOfThree</title> +<indexterm><primary>ArrayOfThree</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ArrayOfThree</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ArrayOfThree</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ArrayOfThree</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ArrayOfOne</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +RexxObjectPtr obj1, obj2, obj3; + +>>--arr = context->ArrayOfThree(obj1, obj2, obj3);----------------------->< +]]> +</programlisting> +<para>Create a new one-dimension array with the specified objects. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj1</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj2</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj3</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The new Rexx array object.</para> +</section> +</section> + +<section id="mthArrayOfTwo"><title>ArrayOfTwo</title> +<indexterm><primary>ArrayOfTwo</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ArrayOfTwo</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ArrayOfTwo</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ArrayOfTwo</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ArrayOfOne</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +RexxObjectPtr obj1, obj2; + +>>--arr = context->ArrayOfTwo(obj1, obj2);------------------------------->< +]]> +</programlisting> +<para>Create a new one-dimension array with the specified objects.. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj1</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj2</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The new Rexx array object.</para> +</section> +</section> + +<section id="mthArrayOfOne"><title>ArrayOfOne</title> +<indexterm><primary>ArrayOfOne</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ArrayOfOne</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ArrayOfOne</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ArrayOfOne</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ArrayOfOne</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +RexxObjectPtr obj; + +>>--arr = context->ArrayOfOne(obj);-------------------------------------->< +]]> +</programlisting> +<para>Create a new one-dimension array with the specified object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to be added.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The new Rexx array object.</para> +</section> +</section> + +<section id="mthArrayPut"><title>ArrayPut</title> +<indexterm><primary>ArrayPut</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ArrayPut</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ArrayPut</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ArrayPut</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ArrayPut</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +RexxObjectPtr obj; +size_t idx; + +>>--context->ArrayPut(arr, obj, idx);------------------------------------>< +]]> +</programlisting> +<para>Replace/add a Rexx object to the Rexx array at the specified index. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>The source Rexx array object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to be added/replaced.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">idx</emphasis></term> + <listitem><para>The index into the Rexx array object. This argument is 1-based.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthArraySize"><title>ArraySize</title> +<indexterm><primary>ArraySize</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ArraySize</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ArraySize</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ArraySize</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ArraySize</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; +size_t sz; + +>>--sz = context->ArraySize(arr);---------------------------------------->< +]]> +</programlisting> +<para>Returns the 1-based index of the last element of the Rexx array. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>The source Rexx array object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The index of the last element of the Rexx array.</para> +</section> +</section> + <section id="mthAttachThread"><title>AttachThread</title> <indexterm><primary>AttachThread</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> @@ -157,6 +801,104 @@ </section> </section> +<section id="mthBufferStringData"><title>BufferStringData</title> +<indexterm><primary>BufferStringData</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>BufferStringData</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>BufferStringData</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>BufferStringData</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>BufferStringData</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxBufferStringObject obj; +POINTER str; + +>>--str = context->BufferStringData(obj);-------------------------------------->< +]]> +</programlisting> +<para>Returns a pointer the Rexx object's data buffer. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The C pointer to the buffer.</para> +</section> +</section> + +<section id="mthBufferStringLength"><title>BufferStringLength</title> +<indexterm><primary>BufferStringLength</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>BufferStringLength</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>BufferStringLength</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>BufferStringLength</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>BufferStringLength</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxBufferStringObject obj; +size_t sz; + +>>--sz = context->BufferStringLength(obj);------------------------------->< +]]> +</programlisting> +<para>Return the length of the data buffer of a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The string length of the Rexx object.</para> +</section> +</section> + <section id="mthCallProgram"><title>CallProgram</title> <indexterm><primary>CallProgram</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -357,6 +1099,168 @@ </section> </section> +<section id="mthDirectoryAt"><title>DirectoryAt</title> +<indexterm><primary>DirectoryAt</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>DirectoryAt</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>DirectoryAt</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>DirectoryAt</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>DirectoryAt</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dirobj; +RexxObjectPtr obj; +CSTRING str; + +>>--obj = context->DirectoryAt(dirobj, str);----------------------------->< +]]> +</programlisting> +<para>Return the object at the specified index. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">dirobj</emphasis></term> + <listitem><para>The source Rexx directory object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The index into the Rexx directory object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx object at the specified index.</para> +</section> +</section> + +<section id="mthDirectoryPut"><title>DirectoryPut</title> +<indexterm><primary>DirectoryPut</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>DirectoryPut</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>DirectoryPut</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>DirectoryPut</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>DirectoryPut</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dirobj; +RexxObjectPtr index; +CSTRING str; + +>>--context->DirectoryPut(dirobj, index, str);--------------------------->< +]]> +</programlisting> +<para>Replace/add a CSTRING to a Rexx directory object at the specified index. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">dirobj</emphasis></term> + <listitem><para>The source Rexx directory object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">index</emphasis></term> + <listitem><para>The index into the Rexx directory object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The C ASCIIZ string value to be placed at the index.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthDirectoryRemove"><title>DirectoryRemove</title> +<indexterm><primary>DirectoryRemove</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>DirectoryRemove</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>DirectoryRemove</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>DirectoryRemove</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>DirectoryRemove</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dirobj; +RexxObjectPtr obj; +CSTRING str; + +>>--obj = context->DirectoryRemove(dirobj, str);------------------------->< +]]> +</programlisting> +<para>Removes and returns the object at the specified index. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">dirobj</emphasis></term> + <listitem><para>The source Rexx directory object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The index into the Rexx directory object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx object removed at the specified index.</para> +</section> +</section> + <section id="mthDouble"><title>Double</title> <indexterm><primary>Double</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -620,6 +1524,60 @@ </section> </section> +<section id="mthFinishBufferStringData"><title>FinishBufferStringData</title> +<indexterm><primary>FinishBufferStringData</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>FinishBufferStringData</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>FinishBufferStringData</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>FinishBufferStringData</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>FinishBufferStringData</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxBufferStringObject obj; +RexxStringObject strobj; +size_t len; + +>>--str = context->FinishBufferStringData(obj, len);--------------------------->< +]]> +</programlisting> +<para>Returns a pointer to the Rexx string object that contains the buffer and sets the +length of the data in the buffer. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">len</emphasis></term> + <listitem><para>The length of the data in the buffer.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx string object.</para> +</section> +</section> + <section id="mthGetApplicationData"><title>GetApplicationData</title> <indexterm><primary>GetApplicationData</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1586,6 +2544,104 @@ </section> </section> +<section id="mthIsArray"><title>IsArray</title> +<indexterm><primary>IsArray</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>IsArray</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>IsArray</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>IsArray</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>IsArray</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; + +>>--flag = context->IsArray(obj);--------------------------------------->< +]]> +</programlisting> +<para>Tests an object to see if it is a RexxDirectoryObject. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>1 = is a RexxArrayObject, 0 = not a RexxArrayObject.</para> +</section> +</section> + +<section id="mthIsDirectory"><title>IsDirectory</title> +<indexterm><primary>IsDirectory</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>IsDirectory</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>IsDirectory</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>IsDirectory</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>IsDirectory</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; + +>>--flag = context->IsDirectory(obj);----------------------------------->< +]]> +</programlisting> +<para>Tests an object to see if it is a RexxDirectoryObject. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>1 = is a RexxDirectoryObject, 0 = not a RexxDirectoryObject.</para> +</section> +</section> + <section id="mthIsInstanceOf"><title>IsInstanceOf</title> <indexterm><primary>IsInstanceOf</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1622,7 +2678,7 @@ >>--flag = context->IsInstanceOf(obj, class);--------------------------->< ]]> </programlisting> -<para>Tests an object to see if is an instance of or an instance of a subclass of the specified class. +<para>Tests an object to see if it is an instance of or an instance of a subclass of the specified class. </para> <section><title>Arguments</title> <variablelist> @@ -1790,6 +2846,55 @@ </section> </section> +<section id="mthIsString"><title>IsString</title> +<indexterm><primary>IsString</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>IsString</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>IsString</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>IsString</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>IsString</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; + +>>--flag = context->IsString(obj);-------------------------------------->< +]]> +</programlisting> +<para>Tests an object to see if is a RexxStringObject. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>1 = is a routine, 0 = not a routine.</para> +</section> +</section> + <section id="mthLanguageLevel"><title>LanguageLevel</title> <indexterm><primary>Language Level</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> @@ -2048,6 +3153,148 @@ </section> </section> +<section id="mthNewArray"><title>NewArray</title> +<indexterm><primary>NewArray</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>NewArray</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>NewArray</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>NewArray</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>NewArray</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject obj; +size_t len; + +>>--obj = context->NewArray(d);------------------------------------------>< +]]> +</programlisting> +<para>Create a Rexx array object with a specific number of dimensions. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">d</emphasis></term> + <listitem><para>The number of dimensions for the Rexx array.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the new Rexx array object.</para> +</section> +</section> + +<section id="mthNewBufferString"><title>NewBufferString</title> +<indexterm><primary>NewBufferString</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>NewBufferString</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>NewBufferString</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>NewBufferString</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>NewBufferString</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxBufferStringObject obj; +size_t len; + +>>--obj = context->NewBufferString(len);--------------------------------->< +]]> +</programlisting> +<para>Create a Rexx string object with a specific buffer size. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">len</emphasis></term> + <listitem><para>The maximum length of the buffer.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the new Rexx object.</para> +</section> +</section> + +<section id="mthNewDirectory"><title>NewDirectory</title> +<indexterm><primary>NewDirectory</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>NewDirectory</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>NewDirectory</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>NewBDirectory</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>NewDirectory</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject obj; + +>>--obj = context->NewDirectory();--------------------------------------->< +]]> +</programlisting> +<para>Create a Rexx directory object. +</para> +<section><title>Arguments</title> +<para>None</para> +</section> +<section><title>Returns</title> +<para>A pointer to the new Rexx directory object.</para> +</section> +</section> + <section id="mthNewMethod"><title>NewMethod</title> <indexterm><primary>NewMethod</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -3480,7 +4727,7 @@ >>--str = context->StringData(obj);-------------------------------------->< ]]> </programlisting> -<para>Convert a Rexx object into a C ASCIIZ string. +<para>Returns a pointer to the Rexx object C ASCIIZ string. </para> <section><title>Arguments</title> <variablelist> @@ -3591,7 +4838,7 @@ >>--sz = context->StringLength(obj);------------------------------------->< ]]> </programlisting> -<para>Return the lenght of the string value of a Rexx object. +<para>Return the length of the string value of a Rexx object. </para> <section><title>Arguments</title> <variablelist> @@ -3605,6 +4852,54 @@ </section> </section> +<section id="mthStringLower"><title>StringLower</title> +<indexterm><primary>StringLower</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>StringLower</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>StringLower</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>StringLower</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>StringLower</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr srcobj, newobj; + +>>--newobj = context->StringLower(srcobj);------------------------------->< +]]> +</programlisting> +<para>Convert the string value of a Rexx object to lower case and return a new Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">srcobj</emphasis></term> + <listitem><para>The source Rexx object to be converted to lower case.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A new Rexx object with the string value lower cased.</para> +</section> +</section> + <section id="mthStringSize"><title>StringSize</title> <indexterm><primary>StringSize</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -3694,7 +4989,7 @@ </para> <section><title>Arguments</title> <variablelist> - <varlistentry><term><emphasis role="italic">n</emphasis></term> + <varlistentry><term><emphasis role="italic">sz</emphasis></term> <listitem><para>The size_t value to be converted.</para></listitem> </varlistentry> </variablelist> @@ -3704,6 +4999,54 @@ </section> </section> +<section id="mthStringUpper"><title>StringUpper</title> +<indexterm><primary>StringUpper</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>StringUpper</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>StringUpper</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>StringUpper</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>StringUpper</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr srcobj, newobj; + +>>--newobj = context->StringUpper(srcobj);------------------------------->< +]]> +</programlisting> +<para>Convert the string value of a Rexx object to upper case and return a new Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">srcobj</emphasis></term> + <listitem><para>The source Rexx object to be converted to upper case.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A new Rexx object with the string value upper cased.</para> +</section> +</section> + <section id="mthTerminate"><title>Terminate</title> <indexterm><primary>Terminate</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-16 20:55:22
|
Revision: 3930 http://oorexx.svn.sourceforge.net/oorexx/?rev=3930&view=rev Author: wdashley Date: 2009-01-16 20:55:10 +0000 (Fri, 16 Jan 2009) Log Message: ----------- More oo api docs. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-16 17:02:47 UTC (rev 3929) +++ docs/trunk/rexxpg/api.sgml 2009-01-16 20:55:10 UTC (rev 3930) @@ -801,6 +801,104 @@ </section> </section> +<section id="mthBufferData"><title>BufferData</title> +<indexterm><primary>BufferData</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>BufferData</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>BufferData</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>BufferData</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>BufferData</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxBufferObject obj; +POINTER str; + +>>--str = context->BufferData(obj);-------------------------------------------->< +]]> +</programlisting> +<para>Returns a pointer the Rexx object's data buffer. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The C pointer to the buffer.</para> +</section> +</section> + +<section id="mthBufferLength"><title>BufferLength</title> +<indexterm><primary>BufferLength</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>BufferLength</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>BufferLength</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>BufferLength</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>BufferLength</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxBufferObject obj; +size_t sz; + +>>--sz = context->BufferLength(obj);------------------------------------->< +]]> +</programlisting> +<para>Return the length of the data buffer of a Rexx object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source Rexx object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The string length of the Rexx object.</para> +</section> +</section> + <section id="mthBufferStringData"><title>BufferStringData</title> <indexterm><primary>BufferStringData</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -2593,6 +2691,55 @@ </section> </section> +<section id="mthIsBuffer"><title>IsBuffer</title> +<indexterm><primary>IsBuffer</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>IsBuffer</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>IsBuffer</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>IsBuffer</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>IsBuffer</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; + +>>--flag = context->IsBuffer(obj);-------------------------------------->< +]]> +</programlisting> +<para>Tests an object to see if it is a RexxBufferObject. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>1 = is a RexxBufferObject, 0 = not a RexxBufferObject.</para> +</section> +</section> + <section id="mthIsDirectory"><title>IsDirectory</title> <indexterm><primary>IsDirectory</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -2797,6 +2944,55 @@ </section> </section> +<section id="mthIsPointer"><title>IsPointer</title> +<indexterm><primary>IsPointer</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>IsPointer</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>IsPointer</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>IsRPointer</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>IsPointer</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; + +>>--flag = context->IsPointer(obj);------------------------------------->< +]]> +</programlisting> +<para>Tests an object to see if is a RexxPointerObject. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>1 = is a RexxPointerObject, 0 = not a RexxPointerObject.</para> +</section> +</section> + <section id="mthIsRoutine"><title>IsRoutine</title> <indexterm><primary>IsRoutine</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -3202,6 +3398,55 @@ </section> </section> +<section id="mthNewBuffer"><title>NewBuffer</title> +<indexterm><primary>NewBuffer</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>NewBuffer</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>NewBuffer</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>NewBuffer</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>NewBuffer</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxBufferObject obj; +size_t len; + +>>--obj = context->NewBuffer(len);--------------------------------------->< +]]> +</programlisting> +<para>Create a Rexx buffer object with a specific buffer size. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">len</emphasis></term> + <listitem><para>The maximum length of the buffer.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the new Rexx object.</para> +</section> +</section> + <section id="mthNewBufferString"><title>NewBufferString</title> <indexterm><primary>NewBufferString</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -3351,6 +3596,55 @@ </section> </section> +<section id="mthNewPointer"><title>NewPointer</title> +<indexterm><primary>NewPointer</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>NewPointer</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>NewPointer</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>NewPointer</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>NewPointer</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxPointerObject obj; +POINTER p; + +>>--obj = context->NewPointer(p);---------------------------------------->< +]]> +</programlisting> +<para>Create a new RexxPointerObject from a C pointer. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">p</emphasis></term> + <listitem><para>The source C pointer.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A new RexxPointerObject.</para> +</section> +</section> + <section id="mthNewRoutine"><title>NewRoutine</title> <indexterm><primary>NewRoutine</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -4189,6 +4483,55 @@ </section> </section> +<section id="mthPointerValue"><title>PointerValue</title> +<indexterm><primary>NPointerValue</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>PointerValue</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>PointerValue</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>PointerValue</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>PointerValue</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxPointerObject obj; +POINTER p; + +>>--p = context->PointerValue(obj);-------------------------------------->< +]]> +</programlisting> +<para>Return the C pointer value from a RexxPointerObject. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The source RexxPointerObject.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A C pointer value.</para> +</section> +</section> + <section id="mthReleaseGlobalReference"><title>ReleaseGlobalReference</title> <indexterm><primary>ReleaseGlobalReference</primary></indexterm> <indexterm><primary>Thread context methods</primary> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2009-01-19 22:28:56
|
Revision: 3965 http://oorexx.svn.sourceforge.net/oorexx/?rev=3965&view=rev Author: wdashley Date: 2009-01-19 22:25:01 +0000 (Mon, 19 Jan 2009) Log Message: ----------- Last of the oo api updates. This all needs to be reviewed carefully. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-19 19:43:39 UTC (rev 3964) +++ docs/trunk/rexxpg/api.sgml 2009-01-19 22:25:01 UTC (rev 3965) @@ -1102,6 +1102,94 @@ </section> </section> +<section id="mthCheckCondition"><title>CheckCondition</title> +<indexterm><primary>CheckCondition</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>CheckCondition</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>CheckCondition</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>CheckCondition</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>CheckCondition</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +logical_t flag; + +>>--flag = context->CheckCondition();------------------------------------>< +]]> +</programlisting> +<para>Checks to see if a condition is active. +</para> +<section><title>Arguments</title> +<para>None. +</para> +</section> +<section><title>Returns</title> +<para>1 = condition is active, 0 = no condition raised.</para> +</section> +</section> + +<section id="mthClearCondition"><title>ClearCondition</title> +<indexterm><primary>ClearCondition</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>ClearCondition</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>ClearCondition</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ClearCondition</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>ClearCondition</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +>>--context->ClearCondition();------------------------------------------->< +]]> +</programlisting> +<para>Clears the current condition. +</para> +<section><title>Arguments</title> +<para>None. +</para> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + <section id="mthCString"><title>CString</title> <indexterm><primary>CString</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1160,6 +1248,58 @@ </section> </section> +<section id="mthDecodeConditionInfo"><title>DecodeConditionInfo</title> +<indexterm><primary>DecodeConditionInfo</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>DecodeConditionInfo</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>DecodeConditionInfo</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>DecodeConditionInfo</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>DecodeConditionInfo</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dirj; +RexxCondition cond; + +>>--context->DecodeConditionInfo(dir, &cond);---------------------------->< +]]> +</programlisting> +<para>Decodes the condition information into a RexxCondition structure. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">dir</emphasis></term> + <listitem><para>The source Rexx directory object containing the condition information.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">cond</emphasis></term> + <listitem><para>A pointer to the RexxCondition structure.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + <section id="mthDetachThread"><title>DetachThread</title> <indexterm><primary>DetachThread</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1520,6 +1660,240 @@ </section> </section> +<section id="mthDropContextVariable"><title>DropContextVariable</title> +<indexterm><primary>DropContextVariable</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>DropContextVariable</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>DropContextVariable</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +CSTRING name; + +>>--context->DropContextVariable(name);------------------------------->< +]]> +</programlisting> +<para>Drops a Rexx variable in the current function context. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>The name of the Rexx variable.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthDropObjectVariable"><title>DropObjectVariable</title> +<indexterm><primary>DropObjectVariable</primary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>DropObjectVariable</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +CSTRING str; + +>>--context->DropObjectVariable(str);------------------------------------>< +]]> +</programlisting> +<para>Drops the Rexx object assigned to the object variable. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The name of the object variable.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthDropStemArrayElement"><title>DropStemArrayElement</title> +<indexterm><primary>DropStemArrayElement</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>DropStemArrayElement</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>DropStemArrayElement</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>DropStemArrayElement</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>DropStemArrayElement</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxStemObject sobj; +size_t n; + +>>--context->DropStemArrayElement(sobj, n);------------------------------>< +]]> +</programlisting> +<para>Drops an element of the Rexx stem object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">sobj</emphasis></term> + <listitem><para>The target Rexx stem object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The Rexx stem object element number.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthDropStemElement"><title>DropStemElement</title> +<indexterm><primary>DropStemElement</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>DropStemElement</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>DropStemElement</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>DropStemElement</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>DropStemElement</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxStemObject sobj; +CSTRING name; + +>>--context->DropStemElement(sobj, name);-------------------------------->< +]]> +</programlisting> +<para>Drops an element of the Rexx stem object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">sobj</emphasis></term> + <listitem><para>The target Rexx stem object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>The Rexx stem object element name.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + +<section id="mthFalse"><title>False</title> +<indexterm><primary>False</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>False</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>False</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>False</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>False</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; + +>>--obj = context->False();---------------------------------------------->< +]]> +</programlisting> +<para>This method returns a Rexx false ( 0 ) object. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A pointer to the new Rexx object.</para> +</section> +</section> + <section id="mthFindClass"><title>FindClass</title> <indexterm><primary>FindClass</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1569,6 +1943,49 @@ </section> </section> +<section id="mthFindContextClass"><title>FindContextClass</title> +<indexterm><primary>FindContextClass</primary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>FindContextClass</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +CSTRING name; +RexxClassObject obj; + +>>--obj = context->FindContextClass(name);------------------------------->< +]]> +</programlisting> +<para>Return the Rexx class object of the current object context. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>The context name to be searched.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx class object of the current object context.</para> +</section> +</section> + <section id="mthFindPackageClass"><title>FindPackageClass</title> <indexterm><primary>FindPackageClass</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1676,6 +2093,149 @@ </section> </section> +<section id="mthForwardMessage"><title>ForwardMessage</title> +<indexterm><primary>ForwardMessage</primary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>ForwardMessage</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +CSTRING str; +RexxObjectPtr obj, ret; +RexxClassObject sobj; +RexxArrayObject arr; + +>>--ret = context->ForwardMessage(obj, str, cobj, arr);------------------>< +]]> +</programlisting> +<para>Forwards a message to a different object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object to recieve the message.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The message name to use.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">cobj</emphasis></term> + <listitem><para>The object's class object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>The array of message arguments to use.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The resulting Rexx object.</para> +</section> +</section> + +<section id="mthGetAllContextVariables"><title>GetAllContextVariables</title> +<indexterm><primary>GetAllContextVariables</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetAllContextVariables</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetAllContextVariables</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject obj; + +>>--obj = context->GetAllContextVariables();-------------------------->< +]]> +</programlisting> +<para>Gets all the Rexx variables in the current function context. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A RexxDirectoryObject with the variable names and values.</para> +</section> +</section> + +<section id="mthGetAllStemElements"><title>GetAllStemElements</title> +<indexterm><primary>GetAllStemElements</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetAllStemElements</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetAllStemElements</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetAllStemElements</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetAllStemElements</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxStemObject sobj; +RexxDirectoryObject obj; + +>>--obj = context->GetAllStemElements(sobj);----------------------------->< +]]> +</programlisting> +<para>Gets all elements of the Rexx stem object and puts them into a Rexx directory object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">sobj</emphasis></term> + <listitem><para>The source Rexx stem object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx directory object.</para> +</section> +</section> + <section id="mthGetApplicationData"><title>GetApplicationData</title> <indexterm><primary>GetApplicationData</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1718,6 +2278,334 @@ </section> </section> +<section id="mthGetArgument"><title>GetArgument</title> +<indexterm><primary>GetArgument</primary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetArgument</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetArgument</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +size_t n; + +>>--obj = context->GetArgument(n);------------------------------------>< +]]> +</programlisting> +<para>Returns the specified argument to the method or function context +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The argument number (1-based).</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx object.</para> +</section> +</section> + +<section id="mthGetArguments"><title>GetArguments</title> +<indexterm><primary>GetArguments</primary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetArguments</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetArguments</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxArrayObject arr; + +>>--arr = context->GetArguments();------------------------------------>< +]]> +</programlisting> +<para>Returns a Rexx array object of the arguments to the method or function context +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>The Rexx array object.</para> +</section> +</section> + +<section id="mthGetCallerContext"><title>GetCallerContext</title> +<indexterm><primary>GetCallerContext</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetCallerContext</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetCallerContext</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; + +>>--obj = context->GetCallerContext();-------------------------------->< +]]> +</programlisting> +<para>Get the context's current caller's context. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>The current caller's context.</para> +</section> +</section> + +<section id="mthGetConditionInfo"><title>GetConditionInfo</title> +<indexterm><primary>GetConditionInfo</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetConditionInfo</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetConditionInfo</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetConditionInfo</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetConditionInfo</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject dir; + +>>--dir = context->GetConditionInfo();-------------------------------->< +]]> +</programlisting> +<para>Returns a Rexx directory object containing the condition information. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>The RexxDirectoryObject containing the condition information.</para> +</section> +</section> + +<section id="mthGetContextDigits"><title>GetContextDigits</title> +<indexterm><primary>GetContextDigits</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetContextDigits</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +stringsize_t sz; + +>>--sz = context->GetContextDigits();--------------------------------->< +]]> +</programlisting> +<para>Get the context's current NUMERIC DIGITS setting. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>The current NUMERIC DIGITS setting.</para> +</section> +</section> + +<section id="mthGetContextForm"><title>GetContextForm</title> +<indexterm><primary>GetContextForm</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetContextForm</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +stringsize_t sz; + +>>--sz = context->GetContextForm();----------------------------------->< +]]> +</programlisting> +<para>Get the context's current NUMERIC FORM setting. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>The current NUMERIC FORM setting.</para> +</section> +</section> + +<section id="mthGetContextFuzz"><title>GetContextFuzz</title> +<indexterm><primary>GetContextFuzz</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetContextFuzz</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +stringsize_t sz; + +>>--sz = context->GetContextFuzz();----------------------------------->< +]]> +</programlisting> +<para>Get the context's current NUMERIC FUZZ setting. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>The current NUMERIC FUZZ setting.</para> +</section> +</section> + +<section id="mthGetContextVariable"><title>GetContextVariable</title> +<indexterm><primary>GetContextVariable</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetContextVariable</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetContextVariable</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +CSTRING name; + +>>--obj = context->GetContextVariable(name);-------------------------->< +]]> +</programlisting> +<para>Gets the value of a Rexx variable in the current function context. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>The name of the Rexx variable.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A RexxObjectPtr value.</para> +</section> +</section> + <section id="mthGetGlobalEnvironment"><title>GetGlobalEnvironment</title> <indexterm><primary>GetGlobalEnvironment</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1806,6 +2694,82 @@ </section> </section> +<section id="mthGetMessageName"><title>GetMessageName</title> +<indexterm><primary>GetMessageName</primary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetMessageName</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +CSTRING str; + +>>--str = context->GetMessageName(obj);------------------------------->< +]]> +</programlisting> +<para>Returns name of the current message context. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A pointer to the current context message name.</para> +</section> +</section> + +<section id="mthGetMethod"><title>GetMethod</title> +<indexterm><primary>GetMethod</primary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetMethod</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxMethodObject obj; + +>>--obj = context->GetMethod();--------------------------------------->< +]]> +</programlisting> +<para>Returns a pointer to a the current RexxMethodObject. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A Pointer to the current RexxMethodObject.</para> +</section> +</section> + <section id="mthGetMethodPackage"><title>GetMethodPackage</title> <indexterm><primary>GetMethodPackage</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -1855,6 +2819,49 @@ </section> </section> +<section id="mthGetObjectVariable"><title>GetObjectVariable</title> +<indexterm><primary>GetObjectVariable</primary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetObjectVariable</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +CSTRING str; +RexxObjectPtr obj; + +>>--obj = context->GetObjectVariable(str);------------------------------->< +]]> +</programlisting> +<para>Returns the Rexx object assigned to the object variable. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The name of the object variable.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx object assigned to the object variable.</para> +</section> +</section> + <section id="mthGetPackageClasses"><title>GetPackageClasses</title> <indexterm><primary>GetPackageClasses</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -2100,6 +3107,82 @@ </section> </section> +<section id="mthGetRoutine"><title>GetRoutine</title> +<indexterm><primary>GetRoutine</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetRoutine</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxRoutineObject obj; + +>>--obj = context->GetRoutine();-------------------------------------->< +]]> +</programlisting> +<para>Returns current routine object. +</para> +<section><title>Arguments</title> +<para>None</para> +</section> +<section><title>Returns</title> +<para>The current Rexx routine object.</para> +</section> +</section> + +<section id="mthGetRoutineName"><title>GetRoutineName</title> +<indexterm><primary>GetRoutineName</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetRoutineName</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +CSTRING name; + +>>--name = context->GetRoutineName();--------------------------------->< +]]> +</programlisting> +<para>Returns name of the current routine. +</para> +<section><title>Arguments</title> +<para>None</para> +</section> +<section><title>Returns</title> +<para>A pointer to the current routine name.</para> +</section> +</section> + <section id="mthGetRoutinePackage"><title>GetRoutinePackage</title> <indexterm><primary>GetRoutinePackage</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -2149,6 +3232,284 @@ </section> </section> +<section id="mthGetScope"><title>GetScope</title> +<indexterm><primary>GetScope</primary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetScope</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; + +>>--obj = context->GetScope();---------------------------------------->< +]]> +</programlisting> +<para>Returns a pointer to a the current object scope. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A pointer to the current Rexx object scope.</para> +</section> +</section> + +<section id="mthGetSelf"><title>GetSelf</title> +<indexterm><primary>GetSelf</primary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetSelf</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; + +>>--obj = context->GetSelf();----------------------------------------->< +]]> +</programlisting> +<para>Returns a pointer to a the current object context. This value can be safely used in a +different context to refer to this Rexx object. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A pointer to the current Rexx object context.</para> +</section> +</section> + +<section id="mthGetStemArrayElement"><title>GetStemArrayElement</title> +<indexterm><primary>GetStemArrayElement</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetStemArrayElement</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetStemArrayElement</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetStemArrayElement</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetStemArrayElement</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxStemObject sobj; +RexxObjectPtr obj; +size_t n; + +>>--obj = context->GetStemArrayElement(sobj, n);------------------------->< +]]> +</programlisting> +<para>Gets an element of the Rexx stem object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">sobj</emphasis></term> + <listitem><para>The source Rexx stem object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">n</emphasis></term> + <listitem><para>The Rexx stem object element number. + If no element exists with the specified number then NULL is returned.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx stem object element or NULL.</para> +</section> +</section> + +<section id="mthGetStemElement"><title>GetStemElement</title> +<indexterm><primary>GetStemElement</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetStemElement</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetStemElement</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetStemElement</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetStemElement</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxStemObject sobj; +RexxObjectPtr obj; +CSTRING name; + +>>--obj = context->GetStemElement(sobj, name);--------------------------->< +]]> +</programlisting> +<para>Gets an element of the Rexx stem object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">sobj</emphasis></term> + <listitem><para>The source Rexx stem object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">name</emphasis></term> + <listitem><para>The Rexx stem object element name.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object value for the Rexx stem object element. + If no element exists for the specified name then NULL is returned. + </para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx stem object element or NULL.</para> +</section> +</section> + +<section id="mthGetStemValue"><title>GetStemValue</title> +<indexterm><primary>GetStemValue</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>GetStemValue</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>GetStemValue</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetStemValue</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>GetStemValue</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxStemObject sobj; +RexxObjectPtr obj; +CSTRING name; + +>>--obj = context->GetStemValue(sobj);----------------------------------->< +]]> +</programlisting> +<para>Gets the base name value of the Rexx stem object. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">sobj</emphasis></term> + <listitem><para>The source Rexx stem object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>The Rexx stem object containing the base name of the stem.</para> +</section> +</section> + +<section id="mthGetSuper"><title>GetSuper</title> +<indexterm><primary>GetSuper</primary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>GetSuper</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>No</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; + +>>--obj = context->GetSuper();---------------------------------------->< +]]> +</programlisting> +<para>Returns a pointer to a the current object's super class. This value can be safely used in a +different context to refer to this Rexx object's super class. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A pointer to the current Rexx object's super class.</para> +</section> +</section> + <section id="mthHalt"><title>Halt</title> <indexterm><primary>Halt</primary></indexterm> <indexterm><primary>Rexx instance context methods</primary> @@ -2275,6 +3636,44 @@ </section> </section> +<section id="mthInvalidRoutine"><title>InvalidRoutine</title> +<indexterm><primary>InvalidRoutine</primary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>InvalidRoutine</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>No</entry></row> +<row><entry>Method</entry><entry>No</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>No</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxDirectoryObject obj; + +>>--context->InvalidRoutine();---------------------------------------->< +]]> +</programlisting> +<para>???????????????????????????????????????????? +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>Void.</para> +</section> +</section> + <section id="mthInt32"><title>Int32</title> <indexterm><primary>Int32</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -3042,6 +4441,55 @@ </section> </section> +<section id="mthIsStem"><title>IsStem</title> +<indexterm><primary>IsStem</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>IsStem</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>IsStem</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>IsStem</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>IsStem</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; +logical_t flag; + +>>--flag = context->IsStem(obj);---------------------------------------->< +]]> +</programlisting> +<para>Tests an object to see if is a RexxStemObject. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>1 = is a routine, 0 = not a routine.</para> +</section> +</section> + <section id="mthIsString"><title>IsString</title> <indexterm><primary>IsString</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -3701,6 +5149,55 @@ </section> </section> +<section id="mthNewStem"><title>NewStem</title> +<indexterm><primary>NewStem</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>NewStem</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>NewStem</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>NewStem</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>NewStem</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxStemObject obj; +CSTRING str; + +>>--obj = context->NewStem(str);----------------------------------------->< +]]> +</programlisting> +<para>Create an new Rexx stem object with the specified base name. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The base name for the new Rexx stem object.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the new Rexx stem object.</para> +</section> +</section> + <section id="mthNewString"><title>NewString</title> <indexterm><primary>NewString</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -3730,7 +5227,7 @@ </informaltable> <programlisting> <![CDATA[ -RexxRoutineObject obj; +RexxStringObject obj; CSTRING str; size_t len; @@ -3756,6 +5253,146 @@ </section> </section> +<section id="mthNewSupplier"><title>NewSupplier</title> +<indexterm><primary>NewSupplier</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>NewSupplier</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>NewSupplier</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>NewSupplier</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>NewSupplier</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxSupplierObject obj; +RexxArrayObject arr1, arr2; + +>>--obj = context->NewSupplier(arr1, arr2);------------------------------>< +]]> +</programlisting> +<para>This method returns a Rexx supplier object based on the supplied argument arrays. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">arr1</emphasis></term> + <listitem><para>The array of supplier items.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">arr2</emphasis></term> + <listitem><para>The array of supplier item names.</para></listitem> + </varlistentry> +</variablelist> +</section> +<section><title>Returns</title> +<para>A pointer to the new Rexx object.</para> +</section> +</section> + +<section id="mthNil"><title>Nil</title> +<indexterm><primary>Nil</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>Nil</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>Nil</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>Nil</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>Nil</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxObjectPtr obj; + +>>--obj = context->Nil();------------------------------------------------>< +]]> +</programlisting> +<para>This method returns a Rexx nil object. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A pointer to the new Rexx object.</para> +</section> +</section> + +<section id="mthNullString"><title>NullString</title> +<indexterm><primary>NullString</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>NullString</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>NullString</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>NullString</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>NullString</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +RexxStringObject obj; + +>>--obj = context->NullString();----------------------------------------->< +]]> +</programlisting> +<para>This method returns a Rexx string object of zero length. +</para> +<section><title>Arguments</title> +<para>None.</para> +</section> +<section><title>Returns</title> +<para>A pointer to the new Rexx string object.</para> +</section> +</section> + <section id="mthObjectToCSelf"><title>ObjectToCSelf</title> <indexterm><primary>ObjectToCSelf</primary></indexterm> <indexterm><primary>Thread context methods</primary> @@ -4532,6 +6169,273 @@ </section> </section> +<section id="mthRaiseCondition"><title>RaiseCondition</title> +<indexterm><primary>RaiseCondition</primary></indexterm> +<indexterm><primary>Thread context methods</primary> +<secondary>RaiseCondition</secondary></indexterm> +<indexterm><primary>Function context methods</primary> +<secondary>RaiseCondition</secondary></indexterm> +<indexterm><primary>Method context methods</primary> +<secondary>RaiseCondition</secondary></indexterm> +<indexterm><primary>Exit context methods</primary> +<secondary>RaiseCondition</secondary></indexterm> +<informaltable frame="all"> +<tgroup cols="2"> +<colspec colnum="1" colwidth="72pc"> +<colspec colnum="2" colwidth="45pc"> +<tbody> +<row> +<entry><emphasis role="bold">Context</emphasis></entry> +<entry><emphasis role="bold">Available</emphasis></entry> +</row> +<row><entry>Thread</entry><entry>Yes</entry></row> +<row><entry>Method</entry><entry>Yes</entry></row> +<row><entry>Function</entry><entry>Yes</entry></row> +<row><entry>Exit</entry><entry>Yes</entry></row> +<row><entry>Interpreter</entry><entry>No</entry></row> +</tbody> +</tgroup> +</informaltable> +<programlisting> +<![CDATA[ +CSTRING str; +RexxStringObject sobj; +RexxArrayObject arr; +RexxObjectPtr obj[ + +>>--context->RaiseCondition(str, sobj, arr obj);------------------------->< +]]> +</programlisting> +<para>Raise a condition. +</para> +<section><title>Arguments</title> +<variablelist> + <varlistentry><term><emphasis role="italic">str</emphasis></term> + <listitem><para>The condition name.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">sobj</emphasis></term> + <listitem><para>The condition number as a Rexx string object.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">arr</emphasis></term> + <listitem><para>A Rexx array object containing the substitutable arguments for the condition message.</para></listitem> + </varlistentry> + <varlistentry><term><emphasis role="italic">obj</emphasis></term> + <listitem><para>The Rexx object which caused the condition.</para></listitem> + </varlistentry> +</vari... [truncated message content] |
From: <wda...@us...> - 2009-01-20 15:57:39
|
Revision: 3975 http://oorexx.svn.sourceforge.net/oorexx/?rev=3975&view=rev Author: wdashley Date: 2009-01-20 15:57:33 +0000 (Tue, 20 Jan 2009) Log Message: ----------- Removed the sections for the oo api arguments and return values so they do not appear in the toc. Makes for a much better appearance. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-20 05:02:57 UTC (rev 3974) +++ docs/trunk/rexxpg/api.sgml 2009-01-20 15:57:33 UTC (rev 3975) @@ -158,7 +158,7 @@ <para>This method has four forms. It create a new one-dimension array with the specified objects. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj1</emphasis></term> <listitem><para>The Rexx object to be added.</para></listitem> @@ -173,11 +173,9 @@ <listitem><para>The Rexx object to be added.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The new Rexx array object.</para> </section> -</section> <section id="mthArrayAppend"><title>ArrayAppend</title> <indexterm><primary>ArrayAppend</primary></indexterm> @@ -217,7 +215,7 @@ </programlisting> <para>Append a Rexx object to the end of the Rexx array. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">arr</emphasis></term> <listitem><para>The source Rexx array object.</para></listitem> @@ -226,11 +224,9 @@ <listitem><para>The Rexx object to be appended.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The number of elements in the Rexx array object.</para> </section> -</section> <section id="mthArrayAppendString"><title>ArrayAppendString</title> <indexterm><primary>ArrayAppendString</primary></indexterm> @@ -270,7 +266,7 @@ </programlisting> <para>Append a Rexx object to the end of the Rexx array. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">arr</emphasis></term> <listitem><para>The source Rexx array object.</para></listitem> @@ -282,11 +278,9 @@ <listitem><para>The length of the CSTRING.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The number of elements in the Rexx array object.</para> </section> -</section> <section id="mthArrayAt"><title>ArrayAt</title> <indexterm><primary>ArrayAt</primary></indexterm> @@ -326,7 +320,7 @@ </programlisting> <para>Return the object at the specified index. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">arr</emphasis></term> <listitem><para>The source Rexx array object.</para></listitem> @@ -335,11 +329,9 @@ <listitem><para>The index into the Rexx array object. This argument is 1-based.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx object at the specified index.</para> </section> -</section> <section id="mthArrayDimension"><title>ArrayDimension</title> <indexterm><primary>ArrayDimension</primary></indexterm> @@ -378,17 +370,15 @@ </programlisting> <para>Returns number of dimensions of the Rexx array. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">arr</emphasis></term> <listitem><para>The source Rexx array object.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The number of dimensions of the Rexx array.</para> </section> -</section> <section id="mthArrayItems"><title>ArrayItems</title> <indexterm><primary>ArrayItems</primary></indexterm> @@ -427,17 +417,15 @@ </programlisting> <para>Returns number of elements in the Rexx array. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">arr</emphasis></term> <listitem><para>The source Rexx array object.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The number of elements in the Rexx array.</para> </section> -</section> <section id="mthArrayOfFour"><title>ArrayOfFour</title> <indexterm><primary>ArrayOfFour</primary></indexterm> @@ -476,7 +464,7 @@ </programlisting> <para>Create a new one-dimension array with the specified objects. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj1</emphasis></term> <listitem><para>The Rexx object to be added.</para></listitem> @@ -491,11 +479,9 @@ <listitem><para>The Rexx object to be added.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The new Rexx array object.</para> </section> -</section> <section id="mthArrayOfThree"><title>ArrayOfThree</title> <indexterm><primary>ArrayOfThree</primary></indexterm> @@ -534,7 +520,7 @@ </programlisting> <para>Create a new one-dimension array with the specified objects. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj1</emphasis></term> <listitem><para>The Rexx object to be added.</para></listitem> @@ -546,11 +532,9 @@ <listitem><para>The Rexx object to be added.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The new Rexx array object.</para> </section> -</section> <section id="mthArrayOfTwo"><title>ArrayOfTwo</title> <indexterm><primary>ArrayOfTwo</primary></indexterm> @@ -589,7 +573,7 @@ </programlisting> <para>Create a new one-dimension array with the specified objects.. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj1</emphasis></term> <listitem><para>The Rexx object to be added.</para></listitem> @@ -598,11 +582,9 @@ <listitem><para>The Rexx object to be added.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The new Rexx array object.</para> </section> -</section> <section id="mthArrayOfOne"><title>ArrayOfOne</title> <indexterm><primary>ArrayOfOne</primary></indexterm> @@ -641,17 +623,15 @@ </programlisting> <para>Create a new one-dimension array with the specified object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx object to be added.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The new Rexx array object.</para> </section> -</section> <section id="mthArrayPut"><title>ArrayPut</title> <indexterm><primary>ArrayPut</primary></indexterm> @@ -691,7 +671,7 @@ </programlisting> <para>Replace/add a Rexx object to the Rexx array at the specified index. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">arr</emphasis></term> <listitem><para>The source Rexx array object.</para></listitem> @@ -703,11 +683,9 @@ <listitem><para>The index into the Rexx array object. This argument is 1-based.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthArraySize"><title>ArraySize</title> <indexterm><primary>ArraySize</primary></indexterm> @@ -746,17 +724,15 @@ </programlisting> <para>Returns the 1-based index of the last element of the Rexx array. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">arr</emphasis></term> <listitem><para>The source Rexx array object.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The index of the last element of the Rexx array.</para> </section> -</section> <section id="mthAttachThread"><title>AttachThread</title> <indexterm><primary>AttachThread</primary></indexterm> @@ -789,17 +765,15 @@ <para>Attaches the current thread to the Rexx interpreter instance pointed to by the <emphasis role="italic">context</emphasis> pointer. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">tc</emphasis></term> <listitem><para>Pointer to a RexxThreadContext pointer.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Boolean value. 0 = success, 1 = failure.</para> </section> -</section> <section id="mthBufferData"><title>BufferData</title> <indexterm><primary>BufferData</primary></indexterm> @@ -838,17 +812,15 @@ </programlisting> <para>Returns a pointer the Rexx object's data buffer. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The source Rexx object.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The C pointer to the buffer.</para> </section> -</section> <section id="mthBufferLength"><title>BufferLength</title> <indexterm><primary>BufferLength</primary></indexterm> @@ -887,17 +859,15 @@ </programlisting> <para>Return the length of the data buffer of a Rexx object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The source Rexx object.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The string length of the Rexx object.</para> </section> -</section> <section id="mthBufferStringData"><title>BufferStringData</title> <indexterm><primary>BufferStringData</primary></indexterm> @@ -936,17 +906,15 @@ </programlisting> <para>Returns a pointer the Rexx object's data buffer. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The source Rexx object.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The C pointer to the buffer.</para> </section> -</section> <section id="mthBufferStringLength"><title>BufferStringLength</title> <indexterm><primary>BufferStringLength</primary></indexterm> @@ -985,17 +953,15 @@ </programlisting> <para>Return the length of the data buffer of a Rexx object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The source Rexx object.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The string length of the Rexx object.</para> </section> -</section> <section id="mthCallProgram"><title>CallProgram</title> <indexterm><primary>CallProgram</primary></indexterm> @@ -1035,7 +1001,7 @@ </programlisting> <para>Returns the result object of the routine. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">name</emphasis></term> <listitem><para>The ASCIIZ path/name of the Rexx program to call.</para></listitem> @@ -1044,11 +1010,9 @@ <listitem><para>The array of Rexx object arguments to the specified program.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to the result Rexx object returned by the program.</para> </section> -</section> <section id="mthCallRoutine"><title>CallRoutine</title> <indexterm><primary>CallRoutine</primary></indexterm> @@ -1087,7 +1051,7 @@ </programlisting> <para>Returns the result object of the routine. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx routine object to call.</para></listitem> @@ -1096,11 +1060,9 @@ <listitem><para>The array of Rexx object arguments to the specified routine.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to the result Rexx object returned by the routine.</para> </section> -</section> <section id="mthCheckCondition"><title>CheckCondition</title> <indexterm><primary>CheckCondition</primary></indexterm> @@ -1138,14 +1100,12 @@ </programlisting> <para>Checks to see if a condition is active. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None. </para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>1 = condition is active, 0 = no condition raised.</para> </section> -</section> <section id="mthClearCondition"><title>ClearCondition</title> <indexterm><primary>ClearCondition</primary></indexterm> @@ -1181,14 +1141,12 @@ </programlisting> <para>Clears the current condition. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None. </para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthCString"><title>CString</title> <indexterm><primary>CString</primary></indexterm> @@ -1232,7 +1190,7 @@ The first converts a Rexx object into a C ASCIIZ string. The second converts C ASCIIZ string into a Rexx object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The source Rexx object for the conversion for the first form of the method.</para></listitem> @@ -1241,12 +1199,10 @@ <listitem><para>The source C ASCII string for the conversion for the second form of the method.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Returns an C ASCII string for the first form of the method. Returns a Rexx object for the second form of the method.</para> </section> -</section> <section id="mthDecodeConditionInfo"><title>DecodeConditionInfo</title> <indexterm><primary>DecodeConditionInfo</primary></indexterm> @@ -1285,7 +1241,7 @@ </programlisting> <para>Decodes the condition information into a RexxCondition structure. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">dir</emphasis></term> <listitem><para>The source Rexx directory object containing the condition information.</para></listitem> @@ -1294,11 +1250,9 @@ <listitem><para>A pointer to the RexxCondition structure.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthDetachThread"><title>DetachThread</title> <indexterm><primary>DetachThread</primary></indexterm> @@ -1329,13 +1283,11 @@ <para>Detaches the current thread to the Rexx thread instance pointed to by the <emphasis role="italic">context</emphasis> pointer. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthDirectoryAt"><title>DirectoryAt</title> <indexterm><primary>DirectoryAt</primary></indexterm> @@ -1375,7 +1327,7 @@ </programlisting> <para>Return the object at the specified index. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">dirobj</emphasis></term> <listitem><para>The source Rexx directory object.</para></listitem> @@ -1384,11 +1336,9 @@ <listitem><para>The index into the Rexx directory object.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx object at the specified index.</para> </section> -</section> <section id="mthDirectoryPut"><title>DirectoryPut</title> <indexterm><primary>DirectoryPut</primary></indexterm> @@ -1428,7 +1378,7 @@ </programlisting> <para>Replace/add a CSTRING to a Rexx directory object at the specified index. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">dirobj</emphasis></term> <listitem><para>The source Rexx directory object.</para></listitem> @@ -1440,11 +1390,9 @@ <listitem><para>The C ASCIIZ string value to be placed at the index.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthDirectoryRemove"><title>DirectoryRemove</title> <indexterm><primary>DirectoryRemove</primary></indexterm> @@ -1484,7 +1432,7 @@ </programlisting> <para>Removes and returns the object at the specified index. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">dirobj</emphasis></term> <listitem><para>The source Rexx directory object.</para></listitem> @@ -1493,11 +1441,9 @@ <listitem><para>The index into the Rexx directory object.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx object removed at the specified index.</para> </section> -</section> <section id="mthDouble"><title>Double</title> <indexterm><primary>Double</primary></indexterm> @@ -1541,7 +1487,7 @@ The first form converts C double value to a Rexx object. The second form converts a Rexx object to a C double value. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> <listitem><para>The double value to be converted in the first form of the method. @@ -1551,12 +1497,10 @@ <listitem><para>The Rexx object to be converted..</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Returns a Rexx object with the string value of the double value in the first form of the method. 0 - success, 1 = failure in the second form of the method.</para> </section> -</section> <section id="mthDoubleToObject"><title>DoubleToObject</title> <indexterm><primary>DoubleToObject</primary></indexterm> @@ -1595,17 +1539,15 @@ </programlisting> <para>Converts C double value to a Rexx object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> <listitem><para>The double value to be converted.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Rexx object with the string value of the double value.</para> </section> -</section> <section id="mthDoubleToObjectWithPrecision"><title>DoubleToObjectWithPrecision</title> <indexterm><primary>DoubleToObjectWithPrecision</primary></indexterm> @@ -1645,7 +1587,7 @@ </programlisting> <para>Converts C double value to a Rexx object with a specific precision. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> <listitem><para>The double value to be converted.</para></listitem> @@ -1654,11 +1596,9 @@ <listitem><para>The precision to be used for the conversion.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Rexx object with the string value of the double value.</para> </section> -</section> <section id="mthDropContextVariable"><title>DropContextVariable</title> <indexterm><primary>DropContextVariable</primary></indexterm> @@ -1692,17 +1632,15 @@ </programlisting> <para>Drops a Rexx variable in the current function context. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">name</emphasis></term> <listitem><para>The name of the Rexx variable.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthDropObjectVariable"><title>DropObjectVariable</title> <indexterm><primary>DropObjectVariable</primary></indexterm> @@ -1734,17 +1672,15 @@ </programlisting> <para>Drops the Rexx object assigned to the object variable. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">str</emphasis></term> <listitem><para>The name of the object variable.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthDropStemArrayElement"><title>DropStemArrayElement</title> <indexterm><primary>DropStemArrayElement</primary></indexterm> @@ -1783,7 +1719,7 @@ </programlisting> <para>Drops an element of the Rexx stem object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">sobj</emphasis></term> <listitem><para>The target Rexx stem object.</para></listitem> @@ -1792,11 +1728,9 @@ <listitem><para>The Rexx stem object element number.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthDropStemElement"><title>DropStemElement</title> <indexterm><primary>DropStemElement</primary></indexterm> @@ -1835,7 +1769,7 @@ </programlisting> <para>Drops an element of the Rexx stem object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">sobj</emphasis></term> <listitem><para>The target Rexx stem object.</para></listitem> @@ -1844,11 +1778,9 @@ <listitem><para>The Rexx stem object element name.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthFalse"><title>False</title> <indexterm><primary>False</primary></indexterm> @@ -1886,13 +1818,11 @@ </programlisting> <para>This method returns a Rexx false ( 0 ) object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the new Rexx object.</para> </section> -</section> <section id="mthFindClass"><title>FindClass</title> <indexterm><primary>FindClass</primary></indexterm> @@ -1931,17 +1861,15 @@ </programlisting> <para>Returns a pointer to the specified class object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">name</emphasis></term> <listitem><para>An ASCIIZ string containing the name of the class.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to the class object.</para> </section> -</section> <section id="mthFindContextClass"><title>FindContextClass</title> <indexterm><primary>FindContextClass</primary></indexterm> @@ -1974,17 +1902,15 @@ </programlisting> <para>Return the Rexx class object of the current object context. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">name</emphasis></term> <listitem><para>The context name to be searched.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx class object of the current object context.</para> </section> -</section> <section id="mthFindPackageClass"><title>FindPackageClass</title> <indexterm><primary>FindPackageClass</primary></indexterm> @@ -2024,7 +1950,7 @@ </programlisting> <para>Returns a pointer to the specified class object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">pkg</emphasis></term> <listitem><para>The package object which contains the class.</para></listitem> @@ -2033,11 +1959,9 @@ <listitem><para>An ASCIIZ string containing the name of the class.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to the class object.</para> </section> -</section> <section id="mthFinishBufferStringData"><title>FinishBufferStringData</title> <indexterm><primary>FinishBufferStringData</primary></indexterm> @@ -2078,7 +2002,7 @@ <para>Returns a pointer to the Rexx string object that contains the buffer and sets the length of the data in the buffer. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The source Rexx object.</para></listitem> @@ -2087,11 +2011,9 @@ <listitem><para>The length of the data in the buffer.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx string object.</para> </section> -</section> <section id="mthForwardMessage"><title>ForwardMessage</title> <indexterm><primary>ForwardMessage</primary></indexterm> @@ -2126,7 +2048,7 @@ </programlisting> <para>Forwards a message to a different object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx object to recieve the message.</para></listitem> @@ -2141,11 +2063,9 @@ <listitem><para>The array of message arguments to use.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The resulting Rexx object.</para> </section> -</section> <section id="mthGetAllContextVariables"><title>GetAllContextVariables</title> <indexterm><primary>GetAllContextVariables</primary></indexterm> @@ -2179,13 +2099,11 @@ </programlisting> <para>Gets all the Rexx variables in the current function context. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A RexxDirectoryObject with the variable names and values.</para> </section> -</section> <section id="mthGetAllStemElements"><title>GetAllStemElements</title> <indexterm><primary>GetAllStemElements</primary></indexterm> @@ -2224,17 +2142,15 @@ </programlisting> <para>Gets all elements of the Rexx stem object and puts them into a Rexx directory object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">sobj</emphasis></term> <listitem><para>The source Rexx stem object.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx directory object.</para> </section> -</section> <section id="mthGetApplicationData"><title>GetApplicationData</title> <indexterm><primary>GetApplicationData</primary></indexterm> @@ -2270,13 +2186,11 @@ </programlisting> <para>Returns a pointer to the thread specific application data. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to the application data.</para> </section> -</section> <section id="mthGetArgument"><title>GetArgument</title> <indexterm><primary>GetArgument</primary></indexterm> @@ -2311,17 +2225,15 @@ </programlisting> <para>Returns the specified argument to the method or function context </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> <listitem><para>The argument number (1-based).</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx object.</para> </section> -</section> <section id="mthGetArguments"><title>GetArguments</title> <indexterm><primary>GetArguments</primary></indexterm> @@ -2355,13 +2267,11 @@ </programlisting> <para>Returns a Rexx array object of the arguments to the method or function context </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx array object.</para> </section> -</section> <section id="mthGetCallerContext"><title>GetCallerContext</title> <indexterm><primary>GetCallerContext</primary></indexterm> @@ -2395,13 +2305,11 @@ </programlisting> <para>Get the context's current caller's context. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The current caller's context.</para> </section> -</section> <section id="mthGetConditionInfo"><title>GetConditionInfo</title> <indexterm><primary>GetConditionInfo</primary></indexterm> @@ -2439,13 +2347,11 @@ </programlisting> <para>Returns a Rexx directory object containing the condition information. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The RexxDirectoryObject containing the condition information.</para> </section> -</section> <section id="mthGetContextDigits"><title>GetContextDigits</title> <indexterm><primary>GetContextDigits</primary></indexterm> @@ -2477,13 +2383,11 @@ </programlisting> <para>Get the context's current NUMERIC DIGITS setting. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The current NUMERIC DIGITS setting.</para> </section> -</section> <section id="mthGetContextForm"><title>GetContextForm</title> <indexterm><primary>GetContextForm</primary></indexterm> @@ -2515,13 +2419,11 @@ </programlisting> <para>Get the context's current NUMERIC FORM setting. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The current NUMERIC FORM setting.</para> </section> -</section> <section id="mthGetContextFuzz"><title>GetContextFuzz</title> <indexterm><primary>GetContextFuzz</primary></indexterm> @@ -2553,13 +2455,11 @@ </programlisting> <para>Get the context's current NUMERIC FUZZ setting. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The current NUMERIC FUZZ setting.</para> </section> -</section> <section id="mthGetContextVariable"><title>GetContextVariable</title> <indexterm><primary>GetContextVariable</primary></indexterm> @@ -2594,17 +2494,15 @@ </programlisting> <para>Gets the value of a Rexx variable in the current function context. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">name</emphasis></term> <listitem><para>The name of the Rexx variable.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A RexxObjectPtr value.</para> </section> -</section> <section id="mthGetGlobalEnvironment"><title>GetGlobalEnvironment</title> <indexterm><primary>GetGlobalEnvironment</primary></indexterm> @@ -2642,13 +2540,11 @@ </programlisting> <para>Returns a pointer to a RexxDirectoryObject which contains the global environment variables and their values. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to a RexxDirectoryObject.</para> </section> -</section> <section id="mthGetLocalEnvironment"><title>GetLocalEnvironment</title> <indexterm><primary>GetLocalEnvironment</primary></indexterm> @@ -2686,13 +2582,11 @@ </programlisting> <para>Returns a pointer to a RexxDirectoryObject which contains the local environment variables and their values. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to a RexxDirectoryObject.</para> </section> -</section> <section id="mthGetMessageName"><title>GetMessageName</title> <indexterm><primary>GetMessageName</primary></indexterm> @@ -2724,13 +2618,11 @@ </programlisting> <para>Returns name of the current message context. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the current context message name.</para> </section> -</section> <section id="mthGetMethod"><title>GetMethod</title> <indexterm><primary>GetMethod</primary></indexterm> @@ -2762,13 +2654,11 @@ </programlisting> <para>Returns a pointer to a the current RexxMethodObject. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to the current RexxMethodObject.</para> </section> -</section> <section id="mthGetMethodPackage"><title>GetMethodPackage</title> <indexterm><primary>GetMethodPackage</primary></indexterm> @@ -2807,17 +2697,15 @@ </programlisting> <para>Returns a pointer to a RexxPackageObject which contains the specified method object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx method object to query.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to a RexxPackageObject.</para> </section> -</section> <section id="mthGetObjectVariable"><title>GetObjectVariable</title> <indexterm><primary>GetObjectVariable</primary></indexterm> @@ -2850,17 +2738,15 @@ </programlisting> <para>Returns the Rexx object assigned to the object variable. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">str</emphasis></term> <listitem><para>The name of the object variable.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx object assigned to the object variable.</para> </section> -</section> <section id="mthGetPackageClasses"><title>GetPackageClasses</title> <indexterm><primary>GetPackageClasses</primary></indexterm> @@ -2899,17 +2785,15 @@ </programlisting> <para>Returns a RexxDirectoryObject pointer which contains the public and private classes (name and object) from the specified package object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx package object to query.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to a RexxDirectoryObject.</para> </section> -</section> <section id="mthGetPackageMethods"><title>GetPackageMethods</title> <indexterm><primary>GetPackageMethods</primary></indexterm> @@ -2948,17 +2832,15 @@ </programlisting> <para>Returns a RexxDirectoryObject pointer which contains the public unattached methods (name and object) from the specified package object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx package routine object to query.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to a RexxDirectoryObject.</para> </section> -</section> <section id="mthGetPackagePublicClasses"><title>GetPackagePublicClasses</title> <indexterm><primary>GetPackagePublicClasses</primary></indexterm> @@ -2997,17 +2879,15 @@ </programlisting> <para>Returns a RexxDirectoryObject pointer which contains the public classes (name and object) from the specified package object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx package object to query.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to a RexxDirectoryObject.</para> </section> -</section> <section id="mthGetPackagePublicRoutines"><title>GetPackagePublicRoutines</title> <indexterm><primary>GetPackagePublicRoutines</primary></indexterm> @@ -3046,17 +2926,15 @@ </programlisting> <para>Returns a RexxDirectoryObject pointer which contains the public routines (name and object) from the specified package object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx package object to query.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to a RexxDirectoryObject.</para> </section> -</section> <section id="mthGetPackageRoutines"><title>GetPackageRoutines</title> <indexterm><primary>GetPackageRoutines</primary></indexterm> @@ -3095,17 +2973,15 @@ </programlisting> <para>Returns a RexxDirectoryObject pointer which contains the public and private routines (name and object) from the specified package object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx package routine object to query.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to a RexxDirectoryObject.</para> </section> -</section> <section id="mthGetRoutine"><title>GetRoutine</title> <indexterm><primary>GetRoutine</primary></indexterm> @@ -3137,13 +3013,11 @@ </programlisting> <para>Returns current routine object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The current Rexx routine object.</para> </section> -</section> <section id="mthGetRoutineName"><title>GetRoutineName</title> <indexterm><primary>GetRoutineName</primary></indexterm> @@ -3175,13 +3049,11 @@ </programlisting> <para>Returns name of the current routine. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the current routine name.</para> </section> -</section> <section id="mthGetRoutinePackage"><title>GetRoutinePackage</title> <indexterm><primary>GetRoutinePackage</primary></indexterm> @@ -3220,17 +3092,15 @@ </programlisting> <para>Returns a pointer to a RexxPackageObject which contains the specified routine object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx routine object to query.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A Pointer to a RexxPackageObject.</para> </section> -</section> <section id="mthGetScope"><title>GetScope</title> <indexterm><primary>GetScope</primary></indexterm> @@ -3262,13 +3132,11 @@ </programlisting> <para>Returns a pointer to a the current object scope. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the current Rexx object scope.</para> </section> -</section> <section id="mthGetSelf"><title>GetSelf</title> <indexterm><primary>GetSelf</primary></indexterm> @@ -3301,13 +3169,11 @@ <para>Returns a pointer to a the current object context. This value can be safely used in a different context to refer to this Rexx object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the current Rexx object context.</para> </section> -</section> <section id="mthGetStemArrayElement"><title>GetStemArrayElement</title> <indexterm><primary>GetStemArrayElement</primary></indexterm> @@ -3347,7 +3213,7 @@ </programlisting> <para>Gets an element of the Rexx stem object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">sobj</emphasis></term> <listitem><para>The source Rexx stem object.</para></listitem> @@ -3357,11 +3223,9 @@ If no element exists with the specified number then NULL is returned.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx stem object element or NULL.</para> </section> -</section> <section id="mthGetStemElement"><title>GetStemElement</title> <indexterm><primary>GetStemElement</primary></indexterm> @@ -3401,7 +3265,7 @@ </programlisting> <para>Gets an element of the Rexx stem object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">sobj</emphasis></term> <listitem><para>The source Rexx stem object.</para></listitem> @@ -3415,11 +3279,9 @@ </para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx stem object element or NULL.</para> </section> -</section> <section id="mthGetStemValue"><title>GetStemValue</title> <indexterm><primary>GetStemValue</primary></indexterm> @@ -3459,17 +3321,15 @@ </programlisting> <para>Gets the base name value of the Rexx stem object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">sobj</emphasis></term> <listitem><para>The source Rexx stem object.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The Rexx stem object containing the base name of the stem.</para> </section> -</section> <section id="mthGetSuper"><title>GetSuper</title> <indexterm><primary>GetSuper</primary></indexterm> @@ -3502,13 +3362,11 @@ <para>Returns a pointer to a the current object's super class. This value can be safely used in a different context to refer to this Rexx object's super class. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the current Rexx object's super class.</para> </section> -</section> <section id="mthHalt"><title>Halt</title> <indexterm><primary>Halt</primary></indexterm> @@ -3538,13 +3396,11 @@ </programlisting> <para>Halts the interpreter. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthHaltThread"><title>HaltThread</title> <indexterm><primary>HaltThread</primary></indexterm> @@ -3575,13 +3431,11 @@ <para>Halts the current thread pointed to by the <emphasis role="italic">context</emphasis> pointer. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthHasMethod"><title>HasMethod</title> <indexterm><primary>HasMethod</primary></indexterm> @@ -3621,7 +3475,7 @@ </programlisting> <para>Returns a boolean indicating if an object has the specified method available. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx object to query.</para></listitem> @@ -3630,11 +3484,9 @@ <listitem><para>An ASCIIZ string containing the name of the method.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>1 = has the method available, 0 = does not have the method available.</para> </section> -</section> <section id="mthInvalidRoutine"><title>InvalidRoutine</title> <indexterm><primary>InvalidRoutine</primary></indexterm> @@ -3666,13 +3518,11 @@ </programlisting> <para>???????????????????????????????????????????? </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>Void.</para> </section> -</section> <section id="mthInt32"><title>Int32</title> <indexterm><primary>Int32</primary></indexterm> @@ -3716,7 +3566,7 @@ The first converts a C 32 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. The second converts a Rexx object to a C 32 bit integer pointer to by <emphasis role="italic">n</emphasis>. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> <listitem><para>The C pointer to the interger to be converted or the target of the conversion.</para></listitem> @@ -3725,12 +3575,10 @@ <listitem><para>The Rexx object to be converted.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the Rexx object that represents the C integer in the first forms. The second for returns 0 = success, 1 = failure.</para> </section> -</section> <section id="mthInt32ToObject"><title>Int32ToObject</title> <indexterm><primary>Int32ToObject</primary></indexterm> @@ -3769,17 +3617,15 @@ </programlisting> <para>Convert a C 32 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> <listitem><para>The C pointer to the interger to be converted.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the Rexx object that represents the C integer.</para> </section> -</section> <section id="mthInt64"><title>Int64</title> <indexterm><primary>Int64</primary></indexterm> @@ -3823,7 +3669,7 @@ The first converts a C 64 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. The second converts a Rexx object to a C 64 bit integer pointer to by <emphasis role="italic">n</emphasis>. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> <listitem><para>The C pointer to the interger to be converted or the target of the conversion.</para></listitem> @@ -3832,12 +3678,10 @@ <listitem><para>The Rexx object to be converted.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the Rexx object that represents the C integer in the first forms. The second for returns 0 = success, 1 = failure.</para> </section> -</section> <section id="mthInt64ToObject"><title>Int64ToObject</title> <indexterm><primary>Int64ToObject</primary></indexterm> @@ -3876,17 +3720,15 @@ </programlisting> <para>Convert a C 64 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> <listitem><para>The C pointer to the interger to be converted.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the Rexx object that represents the C integer.</para> </section> -</section> <section id="mthInterpreterVersion"><title>InterpreterVersion</title> <indexterm><primary>InterpreterVersion</primary></indexterm> @@ -3926,13 +3768,11 @@ </programlisting> <para>Returns the version of the interpreter. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>The interpreter version number.</para> </section> -</section> <section id="mthIntptr"><title>Intptr</title> <indexterm><primary>Intptr</primary></indexterm> @@ -3976,7 +3816,7 @@ The first converts a C signed integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. The second converts aRexx object to a C signed integer pointed to by <emphasis role="italic">n</emphasis>. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> <listitem><para>The C pointer to the signed interger to be converted in the first form. @@ -3986,11 +3826,9 @@ <listitem><para>The Rexx object to be converted.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the Rexx object that represents the C signed integer.</para> </section> -</section> <section id="mthIntptrToObject"><title>IntptrToObject</title> <indexterm><primary>IntptrToObject</primary></indexterm> @@ -4029,17 +3867,15 @@ </programlisting> <para>Convert a C signed integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> <listitem><para>The C pointer to the signed interger to be converted.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>A pointer to the Rexx object that represents the C signed integer.</para> </section> -</section> <section id="mthIsArray"><title>IsArray</title> <indexterm><primary>IsArray</primary></indexterm> @@ -4078,17 +3914,15 @@ </programlisting> <para>Tests an object to see if it is a RexxDirectoryObject. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>1 = is a RexxArrayObject, 0 = not a RexxArrayObject.</para> </section> -</section> <section id="mthIsBuffer"><title>IsBuffer</title> <indexterm><primary>IsBuffer</primary></indexterm> @@ -4127,17 +3961,15 @@ </programlisting> <para>Tests an object to see if it is a RexxBufferObject. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>1 = is a RexxBufferObject, 0 = not a RexxBufferObject.</para> </section> -</section> <section id="mthIsDirectory"><title>IsDirectory</title> <indexterm><primary>IsDirectory</primary></indexterm> @@ -4176,17 +4008,15 @@ </programlisting> <para>Tests an object to see if it is a RexxDirectoryObject. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>A pointer to the Rexx object to be tested.</para></listitem> </varlistentry> </variablelist> -</section> -<section><title>Returns</title> +<para><emphasis role="bold">Returns</emphasis></para> <para>1 = is a RexxDirectoryObject, 0 = not a RexxDirectoryObject.</para> </section> -</section> <section id="mthIsInstanceOf"><title>IsInstanceOf</title> <indexterm><primary>IsInstanceOf</primary></indexterm> @@ -4226,7 +4056,7 @@ </programlisting> <para>Tests an object to see if it is an instance of or an instance of a subclass of the specified class. </para> -<section><title>Arguments</title> +<para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>A ... [truncated message content] |
From: <bi...@us...> - 2009-01-22 02:16:57
|
Revision: 3994 http://oorexx.svn.sourceforge.net/oorexx/?rev=3994&view=rev Author: bigrixx Date: 2009-01-22 01:48:16 +0000 (Thu, 22 Jan 2009) Log Message: ----------- fix syntax errors Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-22 01:44:55 UTC (rev 3993) +++ docs/trunk/rexxpg/api.sgml 2009-01-22 01:48:16 UTC (rev 3994) @@ -94,7 +94,7 @@ <para>Open Object Rexx is fundamentally an object-oriented language. All data in the language (including strings and numbers) are represented by object instances. For use in the APIs, there are a number of opaque types that represent instances -of different core objects. The defined object types are:</para> +of different core objects. The defined object types are: </para> <variablelist> <varlistentry><term>RexxObjectPtr</term> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-01-22 02:17:15
|
Revision: 3992 http://oorexx.svn.sourceforge.net/oorexx/?rev=3992&view=rev Author: bigrixx Date: 2009-01-22 01:44:45 +0000 (Thu, 22 Jan 2009) Log Message: ----------- some more api work Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-22 01:39:26 UTC (rev 3991) +++ docs/trunk/rexxpg/api.sgml 2009-01-22 01:44:45 UTC (rev 3992) @@ -46,7 +46,7 @@ <para>This appendix describes how to interface applications to Rexx or extend the Rexx language by using Rexx C++ application programming interfaces (APIs). As used here, the term application refers to programs -written in C++. +written in C++. </para> <para>The features described here let a C++ application extend many parts of the Rexx language or extend an application with Rexx. This includes creating handlers @@ -67,7 +67,7 @@ replacing Rexx system requests. </para></listitem></varlistentry> </variablelist> -<para>Methods, functions, and system exit handlers have similar coding, +<para>Methods, functions, and system exit handlers have similar coding, compilation, and packaging characteristics. </para> <para>In addition, applications can call methods defined on an ooRexx class and @@ -79,10 +79,163 @@ </section> <section id="apiconcepts"><title>Introduction to API Vectors</title> -<para>This section provides a general description of API vectors and how to use +<para>This section provides a general description of API vectors and how to use them.</para> </section> +<section id="apitypes"><title>Data Types Used in APIs</title> +<para>The ooRexx APIs rely on a variety of special C++ types for interfacing with +the interpreter. Some of these types are specific to the Rexx language, while +others are standard types defined by C++. Many of the APIs involve conversion +between types, while others require having values of a specific type to function. +This section explains the different types and the rules for using them. +</para> +<section id="objecttypes"><title>Rexx Object Types</title> +<para>Open Object Rexx is fundamentally an object-oriented language. All data in +the language (including strings and numbers) are represented by object instances. +For use in the APIs, there are a number of opaque types that represent instances +of different core objects. The defined object types are:</para> +</para> +<variablelist> +<varlistentry><term>RexxObjectPtr</term> +<listitem><para>a reference to a Rexx object instance. This is the root of object +hierarchy and can represent any type of object. +</para></listitem></varlistentry> +<varlistentry><term>RexxStringObject</term> +<listitem><para>an instance of the Rexx String class. The APIs have a number of +APIs that allow direct manipulation and creation of Rexx strings. +</para></listitem></varlistentry> +<varlistentry><term>RexxArrayObject</term> +<listitem><para>An instance of a Rexx single-dimension array. Arrays are used +in many places, and there are interfaces provided for direct manipulation of +arrays. +</para></listitem></varlistentry> +<varlistentry><term>RexxDirectoryObject</term> +<listitem><para>An instance of Rexx Directory class. Like arrays, there are +APIs provided for access and manipulating data stored in a directory. +</para></listitem></varlistentry> +<varlistentry><term>RexxStemObject</term> +<listitem><para>An instance of Rexx Stem class. The APIs include a number of +utility routines for accessing and manipulating data in Stem objects. +</para></listitem></varlistentry> +<varlistentry><term>RexxSupplierObject</term> +<listitem><para>An instance of Rexx Supplier class. +</para></listitem></varlistentry> +<varlistentry><term>RexxSupplierObject</term> +<listitem><para>An instance of Rexx Supplier class. +</para></listitem></varlistentry> +<varlistentry><term>RexxClassObject</term> +<listitem><para>An instance of Rexx Class class. +</para></listitem></varlistentry> +<varlistentry><term>RexxPackageObject</term> +<listitem><para>An instance of Rexx Package class. +</para></listitem></varlistentry> +<varlistentry><term>RexxMethodObject</term> +<listitem><para>An instance of Rexx Method class. +</para></listitem></varlistentry> +<varlistentry><term>RexxRoutineObject</term> +<listitem><para>An instance of Rexx Routine class. Routine objects +can be invoked directly from C++ code. +</para></listitem></varlistentry> +<varlistentry><term>RexxPointerObject</term> +<listitem><para>A wrapper around a pointer value. Pointer objects are designed +for constructing Rexx classes that interface with native code subsystems. +</para></listitem></varlistentry> +<varlistentry><term>RexxBufferObject</term> +<listitem><para>An allocatable storage object that can be used for storing native +C++ data. Buffer objects and the contained data are managed using the Rexx object +garbage collector. +</para></listitem></varlistentry> +</variablelist> +</section> +<section id="numerictypes"><title>Rexx Numeric Types</title> +<para>The Routine and Method interfaces support a very complete set of C numeric types as +arguments and return values. In addition, there are also APIs provided for converting between +Rexx Objects and numeric types (and the reverse transformation as well). It is recommended that +you allow the Rexx runtime and APIs to handle conversions between Rexx strings and numeric types to +give behavior consistent with the Rexx built-in methods and functions. +</para> +<para>In addition to a full set of standard numeric types, there are two special types +provided that implement the standard Rexx rules for numbers used internally by Rexx. +These types are:</para> +<variablelist> +<varlistentry><term>wholenumber_t</term> +<listitem><para>conversions involving the wholenumber_t conform to the Rexx whole number +rules. Values are converted using the same internal digits value used by the built-in functions. +For 32-bit versions, this is numeric digits 9, giving a range of 999,999,999 to -999,999,999. +On 64-bit systems, numeric digits 18 is used, giving a range of 999,999,999,999,999,999 to +-999,999,999,999,999,999. +</para></listitem></varlistentry> +<varlistentry><term>stringsize_t</term> +<listitem><para>stringsize_t conversions also conform to the Rexx whole number +rules, with the added restriction that the value must be a non-negative whole number value. The +stringsize_t type is useful for arguments such as string lengths where only a non-negative value is +allowed. The range for 32-bit versions is 999,999,999 to 0, and +999,999,999,999,999,999 to 0 on 64-bit platforms. +</para></listitem></varlistentry> +<varlistentry><term>logical_t</term> +<listitem><para>a Rexx logical value. On conversion from a string value, this must be +either '1' (true) or '0' (false). On conversion back to a string value, a non-zero binary value be converted +to '1' (true) and zero will become '0' (false). +</para></listitem></varlistentry> +</variablelist> +<para>A subset of the integer numeric types are of different sizes depending on the +addressing mode of the system you are compiling on. These types will be 32-bits in size +or 64-bits. The variable size types are: </para> +<variablelist> +<varlistentry><term>size_t</term> +<listitem><para>An unsigned "size" value. This is the value type returned by pointer subtraction. +</para></listitem></varlistentry> +<varlistentry><term>ssize_t</term> +<listitem><para>The signed equivalent to size_t. +</para></listitem></varlistentry> +<varlistentry><term>uintptr_t</term> +<listitem><para>An unsigned integer value that's guaranteed to be the same size as a pointer value. +Use an uintptr_t type if you wish to return a pointer value as a Rexx number. +</para></listitem></varlistentry> +<varlistentry><term>intptr_t</term> +<listitem><para>A signed equivalent to uintptr_t. +</para></listitem></varlistentry> +</variablelist> +<para>The remainder of the numeric types have fixed sizes regardless of the addressing mode.</para> +<variablelist> +<varlistentry><term>int</term> +<listitem><para>A 32-bit signed integer. +</para></listitem></varlistentry> +<varlistentry><term>int32_t</term> +<listitem><para>A 32-bit signed integer. This is equivalent to int. +</para></listitem></varlistentry> +<varlistentry><term>uint32_t</term> +<listitem><para>An unsigned 32-bit integer. +</para></listitem></varlistentry> +<varlistentry><term>int64_t</term> +<listitem><para>A signed 64-bit integer. +</para></listitem></varlistentry> +<varlistentry><term>uint64_t</term> +<listitem><para>An unsigned 64-bit integer. +</para></listitem></varlistentry> +<varlistentry><term>int16_t</term> +<listitem><para>A signed 16-bit integer. +</para></listitem></varlistentry> +<varlistentry><term>uint16_t</term> +<listitem><para>An unsigned 16-bit integer. +</para></listitem></varlistentry> +<varlistentry><term>int8_t</term> +<listitem><para>A signed 8-bit integer. +</para></listitem></varlistentry> +<varlistentry><term>uint8_t</term> +<listitem><para>An unsigned 8-bit integer. +</para></listitem></varlistentry> +<varlistentry><term>float</term> +<listitem><para>A 32-bit floating point number. +</para></listitem></varlistentry> +<varlistentry><term>double</term> +<listitem><para>A 64-bit floating point number. +</para></listitem></varlistentry> +</variablelist +</section> +</section> + <section id="instanceapi"><title>Rexx Interpreter Instance Interface</title> <para>This section describes the Rexx interpreter instance interface and the methods it provides.</para> @@ -857,7 +1010,7 @@ >>--sz = context->BufferLength(obj);------------------------------------->< ]]> </programlisting> -<para>Return the length of the data buffer of a Rexx object. +<para>Return the length of the data buffer of a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -951,7 +1104,7 @@ >>--sz = context->BufferStringLength(obj);------------------------------->< ]]> </programlisting> -<para>Return the length of the data buffer of a Rexx object. +<para>Return the length of the data buffer of a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -1187,8 +1340,8 @@ ]]> </programlisting> <para>There are two forms of this method. -The first converts a Rexx object into a C ASCIIZ string. -The second converts C ASCIIZ string into a Rexx object. +The first converts a Rexx object into a C ASCIIZ string. +The second converts C ASCIIZ string into a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -1484,8 +1637,8 @@ ]]> </programlisting> <para>There are two forms of this method. -The first form converts C double value to a Rexx object. -The second form converts a Rexx object to a C double value. +The first form converts C double value to a Rexx object. +The second form converts a Rexx object to a C double value. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -1537,7 +1690,7 @@ >>--obj = context->DoubleToObject(n);------------------------------------>< ]]> </programlisting> -<para>Converts C double value to a Rexx object. +<para>Converts C double value to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -1585,7 +1738,7 @@ >>--obj = context->DoubleToObject(n, p);--------------------------------->< ]]> </programlisting> -<para>Converts C double value to a Rexx object with a specific precision. +<para>Converts C double value to a Rexx object with a specific precision. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -2223,7 +2376,7 @@ >>--obj = context->GetArgument(n);------------------------------------>< ]]> </programlisting> -<para>Returns the specified argument to the method or function context +<para>Returns the specified argument to the method or function context </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -2265,7 +2418,7 @@ >>--arr = context->GetArguments();------------------------------------>< ]]> </programlisting> -<para>Returns a Rexx array object of the arguments to the method or function context +<para>Returns a Rexx array object of the arguments to the method or function context </para> <para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> @@ -3563,7 +3716,7 @@ ]]> </programlisting> <para>There a two forms of this method. -The first converts a C 32 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +The first converts a C 32 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. The second converts a Rexx object to a C 32 bit integer pointer to by <emphasis role="italic">n</emphasis>. </para> <para><emphasis role="bold">Arguments</emphasis></para> @@ -3615,7 +3768,7 @@ >>--obj = context->Int32ToObject(n);------------------------------------->< ]]> </programlisting> -<para>Convert a C 32 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +<para>Convert a C 32 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -3666,7 +3819,7 @@ ]]> </programlisting> <para>There a two forms of this method. -The first converts a C 64 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +The first converts a C 64 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. The second converts a Rexx object to a C 64 bit integer pointer to by <emphasis role="italic">n</emphasis>. </para> <para><emphasis role="bold">Arguments</emphasis></para> @@ -3718,7 +3871,7 @@ >>--obj = context->Int64ToObject(n);------------------------------------->< ]]> </programlisting> -<para>Convert a C 64 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +<para>Convert a C 64 bit integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -3813,8 +3966,8 @@ ]]> </programlisting> <para>There are two formes of this method. -The first converts a C signed integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. -The second converts aRexx object to a C signed integer pointed to by <emphasis role="italic">n</emphasis>. +The first converts a C signed integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. +The second converts aRexx object to a C signed integer pointed to by <emphasis role="italic">n</emphasis>. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -3865,7 +4018,7 @@ >>--obj = context->IntptrToObject(&n);----------------------------------->< ]]> </programlisting> -<para>Convert a C signed integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. +<para>Convert a C signed integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -4538,8 +4691,8 @@ ]]> </programlisting> <para>This method has two forms. -The first form converts a Rexx object to a C logical value (0 or 1). -The second form converts C logical value to a Rexx object. +The first form converts a Rexx object to a C logical value (0 or 1). +The second form converts C logical value to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -4591,7 +4744,7 @@ >>--obj = context->LogicalToObject(n);----------------------------------->< ]]> </programlisting> -<para>Converts C logical value to a Rexx object. +<para>Converts C logical value to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5309,7 +5462,7 @@ >>--flag = context->ObjectToInt32(obj, &n);------------------------------>< ]]> </programlisting> -<para>Convert a 32 bit integer into a Rexx object. +<para>Convert a 32 bit integer into a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5360,7 +5513,7 @@ >>--flag = context->ObjectToInt64(obj, &n);------------------------------>< ]]> </programlisting> -<para>Convert a 64 bit integer into a Rexx object. +<para>Convert a 64 bit integer into a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5412,7 +5565,7 @@ >>--flag = context->ObjectToIntptr(obj, &n);----------------------------->< ]]> </programlisting> -<para>Convert an integer into a Rexx object. +<para>Convert an integer into a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5463,7 +5616,7 @@ >>--flag = context->ObjectToLogical(obj, &n);---------------------------->< ]]> </programlisting> -<para>Converts a Rexx object to a C logical value (0 or 1). +<para>Converts a Rexx object to a C logical value (0 or 1). </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5513,7 +5666,7 @@ >>--str = context->ObjectToString(obj);---------------------------------->< ]]> </programlisting> -<para>Convert a Rexx object to a Rexx string object. +<para>Convert a Rexx object to a Rexx string object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5561,7 +5714,7 @@ >>--flag = context->ObjectToStringSize(obj, &n);------------------------->< ]]> </programlisting> -<para>Convert a string size number into a Rexx object. +<para>Convert a string size number into a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5611,7 +5764,7 @@ >>--str = context->ObjectToStringValue(obj);----------------------------->< ]]> </programlisting> -<para>Convert a Rexx object to a C ASCOOZ string. +<para>Convert a Rexx object to a C ASCOOZ string. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5659,7 +5812,7 @@ >>--flag = context->ObjectToUintptr(obj, &n);---------------------------->< ]]> </programlisting> -<para>Convert an unsigned integer into a Rexx object. +<para>Convert an unsigned integer into a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5710,7 +5863,7 @@ >>--flag = context->ObjectToUnsignedInt32(obj, &n);---------------------->< ]]> </programlisting> -<para>Convert an unsigned 32 bit integer into a Rexx object. +<para>Convert an unsigned 32 bit integer into a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5761,7 +5914,7 @@ >>--flag = context->ObjectToUnsignedInt64(obj, &n);---------------------->< ]]> </programlisting> -<para>Convert an unsigned 64 bit integer into a Rexx object. +<para>Convert an unsigned 64 bit integer into a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5810,7 +5963,7 @@ >>--flag = context->ObjectToValue(obj, &desc);--------------------------->< ]]> </programlisting> -<para>Convert a Rexx object to a ValueDescriptor struct. +<para>Convert a Rexx object to a ValueDescriptor struct. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5861,7 +6014,7 @@ >>--flag = context->ObjectToWholeNumber(obj, &wn);----------------------->< ]]> </programlisting> -<para>Convert a whole number into a Rexx object. +<para>Convert a whole number into a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7006,7 +7159,7 @@ >>--str = context->StringData(obj);-------------------------------------->< ]]> </programlisting> -<para>Returns a pointer to the Rexx object C ASCIIZ string. +<para>Returns a pointer to the Rexx object C ASCIIZ string. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7054,7 +7207,7 @@ >>--c = context->StringGet(obj, len1, str, len2);------------------------>< ]]> </programlisting> -<para>Copies all or part of the Rexx object string value to the C string buffer. +<para>Copies all or part of the Rexx object string value to the C string buffer. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7113,7 +7266,7 @@ >>--sz = context->StringLength(obj);------------------------------------->< ]]> </programlisting> -<para>Return the length of the string value of a Rexx object. +<para>Return the length of the string value of a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7206,7 +7359,7 @@ >>--obj = context->StringSize(sz);--------------------------------------->< ]]> </programlisting> -<para>Convert a C size_t integer to a Rexx object. +<para>Convert a C size_t integer to a Rexx object. Alias of the <link linkend="mthStringSizeToObject">StringSizeToObject</link> method. </para> <para><emphasis role="bold">Arguments</emphasis></para> @@ -7254,7 +7407,7 @@ >>--obj = context->StringSizeToObject(sz);------------------------------->< ]]> </programlisting> -<para>Convert a C size_t integer to a Rexx object. +<para>Convert a C size_t integer to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7615,8 +7768,8 @@ ]]> </programlisting> <para>There are two forms of this method. -The first converts a C unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. -The second converts a Rexx object into a C unsigned integer pointed to by <emphasis role="italic">n</emphasis>. +The first converts a C unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. +The second converts a Rexx object into a C unsigned integer pointed to by <emphasis role="italic">n</emphasis>. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7668,7 +7821,7 @@ >>--obj = context->UintptrToObject(&n);---------------------------------->< ]]> </programlisting> -<para>Convert a C unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. +<para>Convert a C unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7719,8 +7872,8 @@ ]]> </programlisting> <para>There are two forms of this method. -The first convert a C 32 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. -The second converts a Rexx object a C 32 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis>. +The first convert a C 32 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. +The second converts a Rexx object a C 32 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis>. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7772,7 +7925,7 @@ >>--obj = context->UnsignedInt32ToObject(n);----------------------------->< ]]> </programlisting> -<para>Convert a C 32 bit unsigned integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +<para>Convert a C 32 bit unsigned integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7823,8 +7976,8 @@ ]]> </programlisting> <para>There are two forms of this method. -The first convert a C 64 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. -The second converts a Rexx object a C 64 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis>. +The first convert a C 64 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis> to a Rexx object. +The second converts a Rexx object a C 64 bit unsigned integer pointed to by <emphasis role="italic">n</emphasis>. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7876,7 +8029,7 @@ >>--obj = context->UnsignedInt64ToObject(n);----------------------------->< ]]> </programlisting> -<para>Convert a C 64 bit unsigned integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. +<para>Convert a C 64 bit unsigned integer pointer to by <emphasis role="italic">n</emphasis> to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7921,7 +8074,7 @@ >>--obj = context->ValuesToObject(desc);--------------------------------->< ]]> </programlisting> -<para>Convert a Rexx ValueDescriptor struct array to a Rexx array object. +<para>Convert a Rexx ValueDescriptor struct array to a Rexx array object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -7966,7 +8119,7 @@ >>--obj = context->ValueToObject(&desc);--------------------------------->< ]]> </programlisting> -<para>Convert a Rexx valueDescriptor struct to a Rexx object. +<para>Convert a Rexx valueDescriptor struct to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -8017,8 +8170,8 @@ ]]> </programlisting> <para>There are two forms of this method. -The first form converts a C signed integer to a Rexx object. -The second form converts a a Rexx object to a C signed integer. +The first form converts a C signed integer to a Rexx object. +The second form converts a a Rexx object to a C signed integer. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -8070,7 +8223,7 @@ >>--obj = context->WholeNumberToObject(n);------------------------------->< ]]> </programlisting> -<para>Convert a C signed integer to a Rexx object. +<para>Convert a C signed integer to a Rexx object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-01-24 00:41:22
|
Revision: 4003 http://oorexx.svn.sourceforge.net/oorexx/?rev=4003&view=rev Author: bigrixx Date: 2009-01-24 00:41:18 +0000 (Sat, 24 Jan 2009) Log Message: ----------- More API updates. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-23 22:36:45 UTC (rev 4002) +++ docs/trunk/rexxpg/api.sgml 2009-01-24 00:41:18 UTC (rev 4003) @@ -78,11 +78,6 @@ RexxCreatInterpreter API.</para> </section> -<section id="apiconcepts"><title>Introduction to API Vectors</title> -<para>This section provides a general description of API vectors and how to use -them.</para> -</section> - <section id="apitypes"><title>Data Types Used in APIs</title> <para>The ooRexx APIs rely on a variety of special C++ types for interfacing with the interpreter. Some of these types are specific to the Rexx language, while @@ -236,28 +231,130 @@ </section> </section> +<section id="apiconcepts"><title>Introduction to API Vectors</title> +<para>The Rexx APIs operate through a set of interface vectors that define a +set of interpreter services that are available. There are different inteface +vectors used for different contexts, but they use very similar calling concepts. +</para> +<para>The first interface vector you'll encounter with the programming interfaces is +the RexxInstance value returned by RexxCreateInterpreter. The RexxInstance type is defined +as a struct when compiled for C code, or a C++ class when compiled for ++. The +struct version looks like this:</para> +<programlisting> +struct RexxInstance_ +{ + RexxInstanceInterface *functions; // the interface function vector + void *applicationData; // creator defined data pointer +}; +</programlisting> +<para>The field <emphasis role="italic">applicationData</emphasis> contains any +value that was specified via the APPLICATION_DATA option on the RexxCreateInterpreter call. +This provides easy access any application-specific data needed to interact with the interpreter. +All other interface contexts will include a pointer to the RexxInstance structure, so it is +always possible to recover this data pointer.</para> +<para>The <emphasis role="italic">functions</emphasis> field is a pointer to a second structure +that defines the RexxInstance programming interfaces. The RexxInstance services are ones that +may be called from any thread and in any context. The services are called using C function pointer +fields in the interface structure. The RexxInstanceInterface looks like this:</para> +<programlisting> +typedef struct +{ + wholenumber_t interfaceVersion; // The interface version identifier + + void (RexxEntry *Terminate)(RexxInstance *); + logical_t (RexxEntry *AttachThread)(RexxInstance *, RexxThreadContext **); + size_t (RexxEntry *InterpreterVersion)(RexxInstance *); + size_t (RexxEntry *LanguageLevel)(RexxInstance *); + void (RexxEntry *Halt)(RexxInstance *); + void (RexxEntry *SetTrace)(RexxInstance *, logical_t); +} RexxInstanceInterface; +</programlisting> +<para>The first thing to note is the interface struct contains a field named +<emphasis role="italic">interfaceVersion</emphasis>. The interfaceVersion field +is a version marker that defines the services the called interpreter version supports. +This interface version is incremented any time new functions are added to the interface. +Using the interface version allows application code to reliably check that required +interface functions are available.</para> +<para>The remainder of the fields are functions that can be called to perform RexxInstance +operations. Note that the first argument to all of the functions is a pointer to a RexxInstance +structure. A call to the InterpreterVersion API from C code would look like this:</para> +<programlisting> +size_t version = context->functions->InterpreterVersion(context); +</programlisting> +<para>When using C++ code, the RexxContext struct has convenience methods that simplify calling +these functions:</para> +<programlisting> +size_t version = context->InterpreterVersion(); +</programlisting> +<para>Note that in the C++ call, it is no longer necessary to pass the RexxInstance as the +first object. That's handled automatically be the C++ method.</para> +<para>The RexxThreadContext pointer returned from RexxCreateInterpreter functions the same way. +RexxThreadContext looks like this:</para> +<programlisting> +struct RexxThreadContext_ +{ + RexxInstance *instance; // the owning instance + RexxThreadInterface *functions; // the interface function vector +} +</programlisting> +<para>The RexxThreadContext contains an embedded RexxInstance pointer for the instance it is +associated with. It also contains an interface vector for the functions available with a +RexxThreadContext. The RexxThreadInterface vector has its own version identifer and +function pointer for each of the defined services. +The RexxThreadContext functions all take a RexxThreadContext pointer as +the first argument. The RexxThreadContext struct defines C++ convience methods for accessing +its own function and the functions for the RexxInstance as well. For example, to call +the InterpreterVersion() API from C code, it is necessary to use</para> +<programlisting> +size_t version = context->instance->functions->InterpreterVersion(context->instance); +</programlisting> +<para>The C++ version is simply</para> +<programlisting> +// context is a RexxThreadContext * +size_t version = context->InterpreterVersion(); +</programlisting> +</para> +<para>When the Rexx interpreter makes calls to native code routines and methods, or invokes +exit handlers, the call-outs use context structures specific to the type of callout. These +are the RexxCallContext, RexxMethodContext, and RexxExitContext structures. Each structure +contains a pointer to a RexxThreadContext instance that's valid for the until the call returns. +Because of the embedded RexxThreadContext, each calls may use any of the RexxThreadContext +functions in addition to the functions specific to the call-out type. Each context defines +C++ methods for the embedded RexxInstance and RexxThreadContext functions.</para> +<para>Note that the RexxInstance interface can be used at any time and on any thread. The +RexxThreadContext returned by RexxCreateInterpreter can only be used on the same thread +as the RexxCreateInterpreter call, but is not valid for use in the context of a method, routine, +or exit call-out. In those contexts, the RexxThreadContext instance passed to the call-out +must be used. A RexxThreadContext instance created for a call-out is only valid until the +call returns to the interpreter.<para> +</section> + <section id="instanceapi"><title>Rexx Interpreter Instance Interface</title> <para>This section describes the Rexx interpreter instance interface and the methods it provides.</para> +<section id="instancethread"><title>Attaching Threads</title> </section> +<section id="gcmodel"><title>Garbage Collection Considerations</title> +</section> +</section> <section id="threadapi"><title>Rexx Thread Interface</title> <para>This section describes the Rexx thread interface and the methods it provides.</para> </section> -<section id="methodapi"><title>Rexx Method Interface</title> +<section id="buildinglibs"><title>Building an External Library</title> +<para>This section describes how to build an external library.</para> + +<section id="methodapi"><title>Defining Library Methods</title> <para>This section describes the Rexx method interface and the methods it provides.</para> </section> -<section id="functionapi"><title>Rexx Function Interface</title> +<section id="functionapi"><title>Defining Library Routines</title> <para>This section describes the Rexx external function interface and the methods it provides.</para> </section> - -<section id="buildinglibs"><title>Building an External Library</title> -<para>This section describes how to build an external library.</para> </section> <section id="exitsapi"><title>Rexx Exits Interface</title> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-01-24 00:48:15
|
Revision: 4004 http://oorexx.svn.sourceforge.net/oorexx/?rev=4004&view=rev Author: bigrixx Date: 2009-01-24 00:48:09 +0000 (Sat, 24 Jan 2009) Log Message: ----------- fix syntax errors Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-24 00:41:18 UTC (rev 4003) +++ docs/trunk/rexxpg/api.sgml 2009-01-24 00:48:09 UTC (rev 4004) @@ -313,7 +313,6 @@ // context is a RexxThreadContext * size_t version = context->InterpreterVersion(); </programlisting> -</para> <para>When the Rexx interpreter makes calls to native code routines and methods, or invokes exit handlers, the call-outs use context structures specific to the type of callout. These are the RexxCallContext, RexxMethodContext, and RexxExitContext structures. Each structure @@ -326,7 +325,7 @@ as the RexxCreateInterpreter call, but is not valid for use in the context of a method, routine, or exit call-out. In those contexts, the RexxThreadContext instance passed to the call-out must be used. A RexxThreadContext instance created for a call-out is only valid until the -call returns to the interpreter.<para> +call returns to the interpreter.</para> </section> <section id="instanceapi"><title>Rexx Interpreter Instance Interface</title> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-01-24 00:50:52
|
Revision: 4005 http://oorexx.svn.sourceforge.net/oorexx/?rev=4005&view=rev Author: bigrixx Date: 2009-01-24 00:50:47 +0000 (Sat, 24 Jan 2009) Log Message: ----------- fix syntax errors Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-24 00:48:09 UTC (rev 4004) +++ docs/trunk/rexxpg/api.sgml 2009-01-24 00:50:47 UTC (rev 4005) @@ -332,8 +332,12 @@ <para>This section describes the Rexx interpreter instance interface and the methods it provides.</para> <section id="instancethread"><title>Attaching Threads</title> +<para>This section describes the multi-threading considerations for using a RexxInstance. +</para> </section> <section id="gcmodel"><title>Garbage Collection Considerations</title> +<para>This section describes the garbage collection considerations for using object references. +.</para> </section> </section> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-01-25 18:36:39
|
Revision: 4014 http://oorexx.svn.sourceforge.net/oorexx/?rev=4014&view=rev Author: bigrixx Date: 2009-01-25 18:36:34 +0000 (Sun, 25 Jan 2009) Log Message: ----------- Add section on creating a library packsge Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-25 18:21:38 UTC (rev 4013) +++ docs/trunk/rexxpg/api.sgml 2009-01-25 18:36:34 UTC (rev 4014) @@ -346,19 +346,166 @@ provides.</para> </section> -<section id="buildinglibs"><title>Building an External Library</title> -<para>This section describes how to build an external library.</para> +<section id="buildinglibs"><title>Building an External Native Library</title> +<para>External libraries written in compiled languages (typically C or C++) +provide a means to +interface Rexx programs with other subsystems intended for compile languages. +These libraries are packaged as Dynamic Link Libraries on Windows or shared libraries on +Unix-based systems. +A named library can be loaded using the the ::REQUIRES directive, the +loadLibrary method on the Package class, or by using the EXTERNAL keyword on +a ::ROUTINE or ::METHOD directive. +</para> +<para>When the library is loaded, the interpreter looks for an entry point +in the library named RexxGetPackage(). An external library package is required +to provide a RexxGetPackage() function that returns a pointer to a descriptor +structure that defines the methods and routines contained within the library. +The RexxGetPackage() routine takes no arguments and has a return value of +RexxPackageEntry *. This is normally created using the OOREXX_GET_PACKAGE() +macro defined in the oorexxapi.h include file.</para> +<programlisting> +// package loading stub. +OOREXX_GET_PACKAGE(package); +</programlisting> +<para>Where <emphasis role="italic">package</emphasis> is the name +of the RexxPackageEntry table defined for this library. The package +entry table is a descriptor what is contained within the library. +Note that on Windows, it is necessary to explicility export the +RexxPackageEntry() function when the library is linked. This is the +only name that it's necessary to export.</para> +<para>The RexxPackageEntry structure contains information about the +package and descriptors of any methods and/or routines defined within +the package. The structure looks like this:</para> +<programlisting> +typedef struct _RexxPackageEntry +{ + int size; // size of the structure...helps compatibility + int apiVersion; // version this was compiled with + int requiredVersion; // minimum required interpreter version (0 means any) + const char *packageName; // package identifier + const char *packageVersion; // package version # + RexxPackageLoader loader; // the package loader + RexxPackageUnloader unloader; // the package unloader + struct _RexxRoutineEntry *routines; // routines contained in this package + struct _RexxMethodEntry *methods; // methods contained in this package +} RexxPackageEntry; +</programlisting> +<para>The fields in the RexxPackageEntry have the following functions:</para> +<variablelist> +<varlistentry><term>size and apiVersion</term> +<listitem><para>these fields give the size of the received table and identify +the interpreter level this library has been compiled against. These indicators +will allow additional information to be added to the RexxPackageEntry in the future +which out causing compatibility issues for older libraries. Normally, these two +fields are defined using the STANDARD_PACKAGE_HEADER macro, which will fill in +both values. +</para></listitem></varlistentry> +<varlistentry><term>requiredVersion</term> +<listitem><para>a library can specify the minimum interpreter level required by this +library. The interpreter will only load libraries that match the minimum compatibility +requirement of the library package. A zero value in this field means there's no +minimum level requirement. The macro REXX_CURRENT_INTERPRETER_VERSION will use +the level of interpreter you are compiling against. If REXX_CURRENT_INTERPRETER_VERSION +is specified, then the library package will not load with previous releases. The +API header files will be updated with a macro for each interpreter version. The +version macros are of the form +REXX_INTERPRETER_<emphasis role="italic">version</emphasis>_<emphasis role="italic">level</emphasis>_<emphasis role="italic">revison</emphasis>, +where <emphasis role="italic">version</emphasis>, <emphasis role="italic">level</emphasis>, +and <emphasis role="italic">revison</emphasis> refer to the corresponding values in an +interpreter release number. For example, REXX_INTERPRETER_4_0_0 would indicate that the +4.0.0 interpreter level is the minimum required for the package. +</para></listitem></varlistentry> +<varlistentry><term>packageName</term> +<listitem><para>a descriptive name for this library package. +</para></listitem></varlistentry> +<varlistentry><term>packageVersion</term> +<listitem><para>a version string for this package. The version can be +in whatever form is appropriate for the package. +</para></listitem></varlistentry> +<varlistentry><term>packageLoader</term> +<listitem><para>a function that will be called when the library package is +first loaded by the interpreter. The package loader function is passed a +RexxThreadContext pointer, which will give the package access to Rexx +interpreter services at initialization time. The package loader is optional +and is indicated by a NULL value in the descriptor. +</para></listitem></varlistentry> +<varlistentry><term>packageUnloader</term> +<listitem><para>a function that will be called when the library package is +unloaded by the interpreter. The unloading process happens when the last +interpreter instance is destroyed during the last cleanup stages. This gives +the loaded library an opportunity to clean up any global resources such as +cached Rexx object references. +The package loader is optional +and is indicated by a NULL value in the descriptor. +</para></listitem></varlistentry> +<varlistentry><term>routines</term> +<listitem><para>a pointer to an array of RexxRoutineEntry structures that define +the routines provided by this package. If there are no routines, NULL should +be specified. +See <link linkend="functionapi">Defining Library Routines</link> for details on +creating the exported routine table. +</para></listitem></varlistentry> +<varlistentry><term>method</term> +<listitem><para>a pointer to an array of RexxMethodEntry structures that define +the methods provided by this package. If there are no methods, NULL should +be specified. +See <link linkend="methodapi">Defining Library Methods</link> for details on +creating the exported method table. +</para></listitem></varlistentry> +</variablelist> +<para>Here is an example of a RexxPackageEntry table taken from the rxmath +library package:</para> +<programlisting> +// now build the actual entry list +RexxRoutineEntry rxmath_functions[] = +{ + REXX_TYPED_ROUTINE(MathLoadFuncs, MathLoadFuncs), + REXX_TYPED_ROUTINE(MathDropFuncs, MathDropFuncs), + REXX_TYPED_ROUTINE(RxCalcPi, RxCalcPi), + REXX_TYPED_ROUTINE(RxCalcSqrt, RxCalcSqrt), + REXX_TYPED_ROUTINE(RxCalcExp, RxCalcExp), + REXX_TYPED_ROUTINE(RxCalcLog, RxCalcLog), + REXX_TYPED_ROUTINE(RxCalcLog10, RxCalcLog10), + REXX_TYPED_ROUTINE(RxCalcSinH, RxCalcSinH), + REXX_TYPED_ROUTINE(RxCalcCosH, RxCalcCosH), + REXX_TYPED_ROUTINE(RxCalcTanH, RxCalcTanH), + REXX_TYPED_ROUTINE(RxCalcPower, RxCalcPower), + REXX_TYPED_ROUTINE(RxCalcSin, RxCalcSin), + REXX_TYPED_ROUTINE(RxCalcCos, RxCalcCos), + REXX_TYPED_ROUTINE(RxCalcTan, RxCalcTan), + REXX_TYPED_ROUTINE(RxCalcCotan, RxCalcCotan), + REXX_TYPED_ROUTINE(RxCalcArcSin, RxCalcArcSin), + REXX_TYPED_ROUTINE(RxCalcArcCos, RxCalcArcCos), + REXX_TYPED_ROUTINE(RxCalcArcTan, RxCalcArcTan), + REXX_LAST_ROUTINE() +}; -<section id="methodapi"><title>Defining Library Methods</title> -<para>This section describes the Rexx method interface and the methods it -provides.</para> -</section> +RexxPackageEntry rxmath_package_entry = +{ + STANDARD_PACKAGE_HEADER + REXX_INTERPRETER_4_0_0, // anything after 4.0.0 will work + "RXMATH", // name of the package + "4.0", // package information + NULL, // no load/unload functions + NULL, + rxmath_functions, // the exported functions + NULL // no methods in rxmath. +}; +// package loading stub. +OOREXX_GET_PACKAGE(rxmath); +</programlisting> + <section id="functionapi"><title>Defining Library Routines</title> <para>This section describes the Rexx external function interface and the methods it provides.</para> </section> + +<section id="methodapi"><title>Defining Library Methods</title> +<para>This section describes the Rexx method interface and the methods it +provides.</para> </section> +</section> <section id="exitsapi"><title>Rexx Exits Interface</title> <para>This section describes how to define a Rexx exit.</para> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-01-25 20:04:55
|
Revision: 4017 http://oorexx.svn.sourceforge.net/oorexx/?rev=4017&view=rev Author: bigrixx Date: 2009-01-25 20:04:50 +0000 (Sun, 25 Jan 2009) Log Message: ----------- fix syntax errors Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-25 20:01:07 UTC (rev 4016) +++ docs/trunk/rexxpg/api.sgml 2009-01-25 20:04:50 UTC (rev 4017) @@ -514,7 +514,7 @@ the interpreter runtime to convert call arguments from Rexx objects into primitive types and return values from primitive types back into Rexx objects. These routines are also given access to a rich set of services via the RexxCallContext -interface vector.<?para> +interface vector.</para> <para>The REXX_CLASSIC_ROUTINE() and REXX_TYPED_ROUTINE() take two arguments. The first entry is the package table name for this routine. The second argument is the entry point name of the real native code routine that implements the function. @@ -527,7 +527,7 @@ to create a prototype declarations so the routine entry table can be generated. The oorexxapi.h header file includes REXX_CLASSIC_ROUTINE_PROTOTYPE() and REXX_TYPED_ROUTINE_PROTOTYPE() macros to generate the appropriate declarations. -For example,<para> +For example,</para> <programlisting> // create function declarations for the linker REXX_TYPED_ROUTINE(RxCalcPi); This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-01-25 20:05:31
|
Revision: 4018 http://oorexx.svn.sourceforge.net/oorexx/?rev=4018&view=rev Author: bigrixx Date: 2009-01-25 20:05:26 +0000 (Sun, 25 Jan 2009) Log Message: ----------- fix syntax errors Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-25 20:04:50 UTC (rev 4017) +++ docs/trunk/rexxpg/api.sgml 2009-01-25 20:05:26 UTC (rev 4018) @@ -552,7 +552,7 @@ <para>This section describes the Rexx method interface and the methods it provides.</para> -<section id="routinedcl"><title>Method Declarations</title> +<section id="methoddcl"><title>Method Declarations</title> <para>This section describes how to define an external method. </para> </section> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-01-26 00:26:21
|
Revision: 4020 http://oorexx.svn.sourceforge.net/oorexx/?rev=4020&view=rev Author: bigrixx Date: 2009-01-26 00:26:17 +0000 (Mon, 26 Jan 2009) Log Message: ----------- More API updates. Modified Paths: -------------- docs/trunk/rexxpg/api.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-25 22:25:42 UTC (rev 4019) +++ docs/trunk/rexxpg/api.sgml 2009-01-26 00:26:17 UTC (rev 4020) @@ -543,10 +543,49 @@ </programlisting> <section id="routinedcl"><title>Routine Declarations</title> -<para>This section describes how to define an external routine. +<para>Library routines are created using a series of macros that +create the body of the function. These macros define the routine +arguments and return value in a form that allows the Rexx runtime +to perform argument checking and conversions before calling the +target routine. +These macros are name "RexxRoutine<emphasis role="italic">n</emphasis>, where +<emphasis role="italic">n</emphasis> is the number of arguments you wish to +be passed to your routine. For example,</para> +<programlisting> +RexxRoutine2(int, beep, wholenumber_t, frequency, wholenumber_t, duration) +{ + return Beep(frequency, duration); /* sound beep */ +} +</programlisting> +<para>defines a <emphasis role="italic">beep</emphasis> routine that will be +passed two <emphasis role="italic">wholenumber_t</emphasis> arguments +(<emphasis role="italic">frequency</emphasis> +and <emphasis role="italic">duration</emphasis>). +The return value is an <emphasis role="italic">int</emphasis> value. </para> +<para>An argument can be made optional by prefixing the type with "OPTIONAL_". For example,</para> +<programlisting> +RexxRoutine2(int, beep, wholenumber_t, frequency, OPTIONAL_wholenumber_t, duration) +{ + return Beep(frequency, duration); /* sound beep */ +} +</programlisting> +<para>would define a routine that takes two arguments. The first argument is required, but the +second is optional. Any optional arguments will be passed using an appropriate zero +value for the type. The macros argumentExists(n) or argumentOmitted(n) can reliably test if +an argument was passed. The test argumentExists(2) can be used to test if the duration was specified. +The <emphasis role="italic">n</emphasis> value is origin 1. There are some special argument types +that you can request as additional additional arguments. This will add additional arguments +to your native routine. The argument value specified with argument exists maps to the +arguments passed to your C++ routine rather than the arguments in the originating Rexx call. +See below for details on the optional type arguments.<para> </section> + +<section id="routinetypes"><title>Routine Argument Types</title> +<para>This section describes the Rexx method interface and the methods it +provides.</para> </section> +</section> <section id="methodapi"><title>Defining Library Methods</title> <para>This section describes the Rexx method interface and the methods it This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |