diff options
Diffstat (limited to 'help/en_US/sym_isTargetGapAchieved.xml')
| -rw-r--r-- | help/en_US/sym_isTargetGapAchieved.xml | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/help/en_US/sym_isTargetGapAchieved.xml b/help/en_US/sym_isTargetGapAchieved.xml new file mode 100644 index 0000000..81c99b4 --- /dev/null +++ b/help/en_US/sym_isTargetGapAchieved.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isTargetGapAchieved" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_isTargetGapAchieved</refname> + <refpurpose>To know whether the target gap was reached.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isTargetGapAchieved()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the target gap was reached.</para> + <para>It print whether or not the target gap was reached.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns 1 if the target gap was reached or 0 if the target gap was not reached or -1 if there was an error.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isTargetGapAchieved()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + |