ARSperl
32 results

 view release on metacpan or  search on metacpan

html/manual/ds_schema.html  view on Meta::CPAN 

<HTML>
<HEAD>
<TITLE>ARSperl Manual - Schema Attributes</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

<H2>Schema Attributes Structure</H2>

This HASH structure is returned by function 
<A href="ars_GetSchema.html">ars_GetSchema</a>.

<PRE>
{
 "adminList"            =&gt; <i>list</i> of group ids,
 "changeDiary"          =&gt; <i>list</i> of references to <a href="ds_diaryentry_hash.html">Diary Entry Structures</a>,
 "getListFields"        =&gt; <i>list</i> of references to <A href="ds_elfs.html">Entry List Field Structure</a>,
 "groupList"            =&gt; <B>see below</B>
 "helpText"             =&gt; string,
 "indexList"            =&gt; <i>list</i> of references to <A href="ds_is.html">Index Structure</a>
 "lastChanged"          =&gt; string,
 "owner"                =&gt; string,
 "schema"               =&gt; reference to <a href="ds_schematype.html">schemaType</a> hash, (<B>3.x and above</B>)
 "sortList"             =&gt; <i>list</i>,
 "timestamp"            =&gt; integer,
 "defaultVui"		=&gt; string (5.x only)
}
 </PRE>

<DL>
<DT><B>groupList</B><DD>
   When compiled against <B>3.x</B>, this will be a hash reference containing
   the groupId as the key to the hash and one of: <P> 
   <blockquote>
   <CODE>none</CODE>, <CODE>hidden</CODE>, or <CODE>visible</CODE>
   </blockquote>
   as the value of the hash. <P>

   When compiled under <B>2.x</B> this will be an array reference. The
   array will contain a list of groupId's that can access this schema.
</DL>


<P>

Example:

<PRE>
$s = ars_GetSchema($c, "Group");
print $s-&gt;{"helpText"};
</PRE>
<P>
<HR WIDTH="30%">
<P>
<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Table of Contents </A>
<p>
<address>
Last changes to this page 14th July 1997 by d.j.adams@soton.ac.uk
</address>
</BODY>
</HTML>



( run in 0.598 second using v1.01-cache-2.11-cpan-39bf76dae61 )