ARSperl
view release on metacpan or search on metacpan
html/manual/ars_GetListSchema.html view on Meta::CPAN
<HTML>
<HEAD>
<TITLE>ARSperl Manual - ars_GetListSchema</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<H2><CODE>ars_GetListSchema(ctrl, changedSince, schemaType, name)</CODE></H2>
This function fetches a list of schemas available to the user.
<dl>
<dt><CODE>changedSince</CODE>
<dd> is an optional timestamp that will cause
only schemas newer than that time to be returned.
The default value is 0.<P>
<dt><CODE>schemaType</CODE> - <B>3.x only</B>
<dd> is an optional code number that indicates the schema type(s) to list.
The default value is 0. Other values are:
<ul><table width = "75%">
<tr><td><B>Value</B></td><td><B>Meaning</B></td></tr>
<tr><td>0</td><td>Retrieve all visible/accessible schemas.</td></tr>
<tr><td>1</td><td>Retrieve only visible/accessible base schemas.</td></tr>
<tr><td>2</td><td>Retrieve only visible/accessible join schemas.</td></tr>
<tr><td>4</td><td>Retrieve only visible/accessible join schemas that
depend on the schema named in the ``name'' parameter.
</td></tr>
<tr><td>5</td><td>Retrieve only visible/accessible base schemas that
the schema named in the ``name'' parameter depends
on.
</td></tr>
</table></ul>
<B>Note:</B> In order to retrieve both <B>visible</B> and <B>hidden</B>
schemas you must add 1024 to the schemaType value. <P>
<dt><CODE>name</CODE> - <B>3.x only</B>
<dd> is the (optional) name of the schema to retrieve dependencies for.
</dl>
<P>
<DL>
<DT><B>On success</B><DD>
Returns an array of schema's available.
<DT><B>On failure</B><DD>
Returns <CODE>undef</CODE>.
</DL>
<P>Example:
<br>
To retrieve the full list of all schemas (visible and hidden) accessible
to the user on an ARS version 3.0 server:
<PRE>
@schemas = ars_GetListSchema($c, 0, 0 + 1024);
for ($i = 0; $i <= $#schemas ; $i++) {
print "$schemas[$i]\n";
}
</PRE>
<P>
<HR WIDTH="30%">
<P>
<A HREF="toc.html"><IMG ALT="<--" SRC="arrow.gif" ALIGN=CENTER> Table of Contents </A>
<p>
<address>
Last changes to this page 7th August 1997 by d.j.adams@soton.ac.uk<br>
© J.C.Murphy, J.W.Murphy 1997 arsperl@arsperl.org
</address>
</BODY>
</HTML>
( run in 0.615 second using v1.01-cache-2.11-cpan-39bf76dae61 )