[Arsperl-devel] ARSperl/html/manual ars_CreateEntry.html, 1.1, 1.2 ars_GetListField.html, 1.2, 1.3
Brought to you by:
jeffmurphy
Menu
▾
▴
[Arsperl-devel] ARSperl/html/manual ars_CreateEntry.html, 1.1, 1.2 ars_GetListField.html, 1.2, 1.3 ars_GetListGroup.html, 1.3, 1.4
|
From: Michiel B. <mb...@us...> - 2007-09-25 19:36:46
|
Update of /cvsroot/arsperl/ARSperl/html/manual In directory sc8-pr-cvs11.sourceforge.net:/tmp/cvs-serv4773 Modified Files: ars_CreateEntry.html ars_GetListField.html ars_GetListGroup.html Log Message: updated docs - minor edits Index: ars_CreateEntry.html =================================================================== RCS file: /cvsroot/arsperl/ARSperl/html/manual/ars_CreateEntry.html,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** ars_CreateEntry.html 13 Feb 1997 19:49:55 -0000 1.1 --- ars_CreateEntry.html 25 Sep 2007 19:36:46 -0000 1.2 *************** *** 1,32 **** ! <HTML> ! <HEAD> ! <TITLE>ARSperl Programmer's Manual</TITLE> ! </HEAD> ! <BODY BGCOLOR="#FFFFFF"> - <H2><CODE>ars_CreateEntry(ctrl, schema, field_name1, value1, ...)</CODE></H2> ! This function creates a new entry (row) in the schema. This is ! the same as ``submitting a new ticket''. Pairs of field ids and ! values should follow the schema name. Data types are automatically ! converted. <P> ! <DL> ! <DT><B>On success</B><DD> ! Returns the new entry id. ! <DT><B>On failure</B><DD> ! Returns <CODE>undef</CODE>. ! </DL> ! <P>Example: ! <PRE> ! ($entry_id = ars_CreateEntry($c, "Schema01", $id, $val)) || ! die $ars_errstr; ! </PRE> ! <P> ! <A HREF="toc.html"><IMG ALT="<--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A> ! </BODY> ! </HTML> \ No newline at end of file --- 1,48 ---- ! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> ! <html> ! <head> ! <title>ars_CreateEntry</title> ! </head> ! <body style="background-color: rgb(255, 255, 255);"> ! <h2><code>ars_CreateEntry(ctrl, schema, field_id1, value1, ! ...)</code></h2> ! This function creates a new entry (row) in the schema. This is the same ! as ``submitting a new ticket''. Pairs of field ids and values should ! follow the schema name. Data types are automatically converted. ! <dl> ! <dt><b>On success</b></dt> ! <dd> Returns the new entry id. </dd> ! ! <dt><b>On failure</b></dt> ! ! <dd> Returns <code>undef</code>. </dd> ! ! </dl> ! ! <p>Example 1: </p> ! ! <pre> ($entry_id = ars_CreateEntry($c, "Schema01", $id, $val)) || <br> die $ars_errstr;<br></pre> ! ! <p>Example 2:</p> ! ! <pre> my %fieldname_to_id = ars_GetFieldTable($c, "User") || <br> die $ars_errstr;<br> my $entry_id = ars_CreateEntry($c, "User",<br> $fieldname_to_id{"Login Name"}, "johnd",<br> $fieldname_to_id{"Full Name"}, "John Doe",<br> $fieldname_to_id{"Password"}, "xyz",<br> ) || die $ars_errstr;</pre> ! ! <p> ! <a href="toc.html"><img alt="<--" src="arrow.gif" align="middle"> Back to Table of Contents</a></p> ! ! ! <address> ! Last changes to this page 13th August 2007 by Michiel Beijen<br> ! ! © J.C.Murphy, J.W.Murphy 1997 ar...@ar... ! </address> ! ! </body> ! </html> Index: ars_GetListGroup.html =================================================================== RCS file: /cvsroot/arsperl/ARSperl/html/manual/ars_GetListGroup.html,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** ars_GetListGroup.html 16 Apr 2003 01:40:02 -0000 1.3 --- ars_GetListGroup.html 25 Sep 2007 19:36:46 -0000 1.4 *************** *** 1,41 **** ! <HTML> ! <HEAD> ! <TITLE>ARSperl Manual - ars_GetListGroup</TITLE> ! </HEAD> ! <BODY BGCOLOR="#FFFFFF"> - <H2><CODE>ars_GetListGroup(ctrl, userName=NULL, password=NULL)</CODE></H2> ! Fetch information about the available groups on a server, optionally ! restricting the list to a particular username/password combination. ! <P> See also: ! <A HREF="ds_getlistgroup_hash.html">GetListGroup Hash Values</A>. ! <P> - <DL> - <DT><B>On success</B><DD> - Returns a HASH. - <DT><B>On failure</B><DD> - Returns undef. - </DL> ! <P>Example: ! <PRE> ! ($a = ars_GetListGroup($ctrl)) || ! die "$ars_errstr"; ! </PRE> ! <I>ars_GetListGroup was introduced in version 1.5 of ARSperl</I> - <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 21st July 1997 by jcm...@ar...<BR> ! © J.C.Murphy, J.W.Murphy 1997 ar...@ar... </address> ! </BODY> ! </HTML> --- 1,62 ---- ! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> ! <html> ! <head> ! <title>ars_GetListGroup</title> ! </head> ! <body style="background-color: rgb(255, 255, 255);"> ! <h2><code>ars_GetListGroup(ctrl, userName=NULL, ! password=NULL)</code></h2> ! Fetch information about the available groups on a server, optionally ! restricting the list to a particular username/password combination.<br> ! ! <br> ! ! If you do not specify the userName string, the call requires ! Administrator privilleges and it returns all groups on the system. If ! you do specify the userName, only the groups that the userName belongs ! to are returned. The password string is optional; and is used to ! further specify the user. This is because on pre-7.0 Remedy servers ! more than one user with the same login name can exist. ! <p> See also: <a href="ds_getlistgroup_hash.html">GetListGroup ! Hash Values</a>. </p> ! ! <dl> ! ! <dt><b>On success</b></dt> ! ! <dd> Returns a HASH. </dd> ! ! <dt><b>On failure</b></dt> ! ! <dd> Returns undef. </dd> ! ! </dl> ! ! <p>Example: </p> ! ! <pre> ($a = ars_GetListGroup($ctrl)) || <br> die "$ars_errstr";<br><br>See for another, more detailed example the ars_GetListGroup.pl script in the examples directory of the ARSperl distribution. </pre> ! ! <i>ars_GetListGroup was introduced in version 1.5 of ARSperl</i> ! <p></p> ! ! <hr width="30%"> ! <p><a href="toc.html"><img alt="<--" src="arrow.gif" align="middle"> Table of Contents </a> ! </p> <p> + </p> + <address> ! Last changes to this page 13th August 2007 by Michiel Beijen<br> ! ! © J.C.Murphy, J.W.Murphy 1997 ar...@ar... </address> ! ! </body> ! </html> Index: ars_GetListField.html =================================================================== RCS file: /cvsroot/arsperl/ARSperl/html/manual/ars_GetListField.html,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** ars_GetListField.html 5 Nov 1998 17:31:39 -0000 1.2 --- ars_GetListField.html 25 Sep 2007 19:36:46 -0000 1.3 *************** *** 1,40 **** ! <HTML> ! <HEAD> ! <TITLE>ARSperl Programmer's Manual</TITLE> ! </HEAD> ! <BODY BGCOLOR="#FFFFFF"> - <H2><CODE>ars_GetListField(control,schema,changedsince=0,fieldType)</CODE></H2> ! Fetches the Field ID's for all fields in the schema ! specified. <CODE>changedsince</CODE> is an optional unix timestamp ! and defaults to 0.<P> ! <B>3.x and above</B> ! <UL> ! In 3.x and above, the <code>fieldType</code> parameter allows you ! to specify what field type(s) to retrieve. This is a bitmask. ! <UL> ! 1 = Retrieve data fields <BR> ! 2 = Retrieve trim fields <BR> ! 4 = Retrieve control fields <BR> ! </UL> ! Ergo, fieldType = 6 will return trim and control fields. ! </UL> ! <DL> ! <DT><B>On success</B><DD> ! Returns an array of field ids. ! <DT><B>On failure</B><DD> ! Returns <CODE>undef</CODE>. ! </DL> ! <P>Example: ! <PRE> ! @fields = ars_GetListField($c, "User"); ! </PRE> ! <P> ! <A HREF="toc.html"><IMG ALT="<--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A> ! </BODY> ! </HTML> \ No newline at end of file --- 1,90 ---- ! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> ! <html> ! <head> ! <title>ARSperl Manual - ars_GetListField</title> ! </head> ! <body style="background-color: rgb(255, 255, 255);"> ! <h2><code>ars_GetListField(control,schema,changedsince=0,fieldType)</code></h2> ! Fetches the Field ID's for all fields in the schema specified. <code>changedsince</code> ! is an optional unix timestamp and defaults to 0. ! <ul> ! The <code>fieldType</code> parameter allows you to specify ! what field type(s) to retrieve. This is a bitmask. ! <ul> ! ! <li>Bit 0: Retrieve data fields (AR_FIELD_TYPE_DATA). ! </li> ! ! <li>Bit 1: Retrieve trim fields (AR_FIELD_TYPE_TRIM). ! </li> ! ! <li>Bit 2: Retrieve control fields (AR_FIELD_TYPE_CONTROL). ! </li> ! ! <li>Bit 3: Retrieve page fields (AR_FIELD_TYPE_PAGE). ! </li> ! ! <li>Bit 4: Retrieve page holder fields ! (AR_FIELD_TYPE_PAGE_HOLDER). ! </li> ! ! <li>Bit 5: Retrieve table fields (AR_FIELD_TYPE_TABLE). ! </li> ! ! <li>Bit 6: Retrieve column fields (AR_FIELD_TYPE_COLUMN). ! </li> ! ! <li>Bit 8: Retrieve vendor type fields ! (AR_FIELD_TYPE_VENDOR). ! </li> ! ! <li>Bit 128: Retrieve attachment type fields ! (AR_FIELD_TYPE_ATTACH). ! </li> ! ! <li>Bit 256: Retrieve attachement pool type fields ! (AR_FIELD_TYPE_ATTACH_POOL) ! </li> ! ! </ul> ! ! <br> ! ! Ergo, fieldType = 6 will return trim and control fields. ! </ul> ! ! <dl> ! ! <dt><b>On success</b></dt> ! ! <dd> Returns an array of field ids. </dd> ! ! <dt><b>On failure</b></dt> ! ! <dd> Returns <code>undef</code>. </dd> ! ! </dl> ! ! <p>Example: </p> ! ! <pre> @fields = ars_GetListField($c, "User");<br> </pre> ! ! <p> ! <a href="toc.html"><img alt="<--" src="arrow.gif" align="middle"> Back to Table of Contents</a></p> ! ! <p><a href="toc.html"> </a></p> ! <p></p> ! ! <address>Last changes to this page August 23 2007 by ! mic...@ma...<br> ! ! © J.C.Murphy, J.W.Murphy 1997 ar...@ar... ! </address> ! </body> ! </html> |
