mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 02:18:56 +00:00
f19a2e277e
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@207943 c90b9560-bf6c-de11-be94-00142212c4b1
159 lines
3.5 KiB
XML
159 lines
3.5 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
|
|
<refentry id="function.SDO-Sequence-getProperty">
|
|
<refnamediv>
|
|
<refname>SDO_Sequence::getProperty</refname>
|
|
<refpurpose>
|
|
Return the property for the specified sequence index.
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>SDO_Model_Property</type><methodname>SDO_Sequence::getProperty</methodname>
|
|
<methodparam><type>int</type><parameter>sequence_index</parameter></methodparam>
|
|
</methodsynopsis>
|
|
|
|
&warn.experimental.func;
|
|
|
|
<para>
|
|
Return the property for the specified sequence index.
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>sequence_index</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The position of the element in the sequence.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
An SDO_Model_Property. A return value of NULL means the sequence element does not belong to a property and must therefore be unstructured text.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="exceptions">
|
|
&reftitle.exceptions;
|
|
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>SDO_IndexOutOfBoundsException</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Thrown if the sequence index is less than
|
|
zero or greater than the size of the sequence.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<!-- Use when a CHANGELOG exists
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>Enter the PHP version of change here</entry>
|
|
<entry>Description of change</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
-->
|
|
|
|
|
|
<!-- Use when examples exist
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>SDO_Sequence::getProperty</function> example</title>
|
|
<para>
|
|
Any text that describes the purpose of the example, or
|
|
what goes on in the example should go here (inside the
|
|
<example> tag, not out
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
if ($anexample === true) {
|
|
echo 'Use the PEAR Coding Standards';
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Use the PEAR Coding Standards
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
-->
|
|
|
|
|
|
<!-- Use when adding See Also links
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function></function></member>
|
|
<member>Or <link linkend="somethingelse">something else</link></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
-->
|
|
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|