[Arsperl-devel] ARSperl/html/manual ars_BeginBulkEntryTransaction.html, NONE, 1.1 ars_CreateCharMe

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/arsperl/ARSperl/html/manual
In directory sc8-pr-cvs11.sourceforge.net:/tmp/cvs-serv3915/html/manual

Modified Files:
	ars_CreateActiveLink.html ars_GetCharMenu.html toc.html 
Added Files:
	ars_BeginBulkEntryTransaction.html ars_CreateCharMenu.html 
	ars_CreateContainer.html ars_CreateEscalation.html 
	ars_CreateField.html ars_CreateFilter.html 
	ars_CreateSchema.html ars_CreateVUI.html 
	ars_EndBulkEntryTransaction.html ars_SetActiveLink.html 
	ars_SetCharMenu.html ars_SetContainer.html 
	ars_SetEscalation.html ars_SetField.html ars_SetFilter.html 
	ars_SetImpersonatedUser.html ars_SetSchema.html 
	ars_SetSessionConfiguration.html ars_SetVUI.html 
Log Message:
added ars_Create/SetCharMenu, ars_SetImpersonatedUser

--- NEW FILE: ars_SetSessionConfiguration.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Manual - ars_SetSessionConfiguration</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_SetSessionConfiguration(ctrl, ...)</CODE></H2>

	Set specified client session configuration.

      <DL>
         <DT><B>On success</B><DD>
		Returns 1
         <DT><B>On failure</B><DD>
                Returns 0
      </DL>

      <P>Example:

      <PRE>
	      ars_SetSessionConfiguration( $ctrl, 
                                &amp;ARS::AR_SESS_CLIENT_TYPE, 7000 )
			|| die "$ars_errstr";
      </PRE>

<P>
<I>ars_SetSessionConfiguration was introduced in version 1.90 of ARSperl</I>

<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 30th August 2000 by jcm...@ar...<BR>
&#169; J.C.Murphy, J.W.Murphy 2000 ar...@ar...
</address>
</BODY>
</HTML>

Index: ars_GetCharMenu.html
===================================================================
RCS file: /cvsroot/arsperl/ARSperl/html/manual/ars_GetCharMenu.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** ars_GetCharMenu.html	30 Mar 2003 16:36:30 -0000	1.3
--- ars_GetCharMenu.html	6 Mar 2007 01:54:26 -0000	1.4
***************
*** 13,19 ****
  is the actual menu name as shown in the ARAdmin tool.
  <P>
! <B>Note</B>: This function returns information <I>about</I> the
! menu. It does not return the actual menu items. See 
! <A HREF="ars_GetCharMenuItems.html">ars_GetCharMenuItems</A> for that.
    <DL>
    <DT><B>On success</B><DD>
--- 13,17 ----
  is the actual menu name as shown in the ARAdmin tool.
  <P>
! 
    <DL>
    <DT><B>On success</B><DD>

--- NEW FILE: ars_CreateCharMenu.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_CreateCharMenu</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_CreateCharMenu(ctrl, menuHash)</CODE></H2>

      This function creates a new menu. You must first
      populate the <CODE>menuHash</CODE> before calling this routine.

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example copies an existing menu to a new 
          active link. I.e. it simply re-saves the menu under
          a new name. </I></BLOCKQUOTE>

      <PRE>
      ($m = ars_GetCharMenu($c, "C-foobar")) ||
	    die $ars_errstr;
      $m->{name} = "Copy of ".$m->{name};
      ars_CreateCharMenu($c, $m) || die $ars_errstr;
      </PRE>

Notes: Hash keys <CODE>helpText, owner</CODE> and 
<CODE>changeDiary</CODE> are optional when calling this routine.

This function was introduced in version 1.90 of ARSperl

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_CreateContainer.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_CreateContainer</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_CreateContainer(ctrl, containerHash, removeFlag=TRUE)</CODE></H2>

      This function creates a new container. You must first
      populate the <CODE>containerHash</CODE> before calling this routine.
      <P><CODE>containerHash</CODE> is a 
      <A HREF="ds_container.html">Container Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example copies an existing container to a new 
          container. I.e. it simply re-saves the active link under
          a new name. </I></BLOCKQUOTE>

      <PRE>
      ($ct = ars_GetContainer($c, "C-foobar")) ||
	    die $ars_errstr;
      $ct->{name} = "Copy of ".$ct->{name};
      ars_CreateContainer($c, $ct) || die $ars_errstr;
      </PRE>

Notes: Hash keys <CODE>helpText, owner</CODE> and 
<CODE>changeDiary</CODE> are optional when calling this routine.

This function was introduced in version 1.90 of ARSperl

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_CreateVUI.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_CreateVUI</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_CreateVUI(ctrl, vuiHash)</CODE></H2>

      This function creates a new VUI. You must first
      populate the <CODE>vuiHash</CODE> before calling this routine.
      <P><CODE>vuiHash</CODE> is an 
      <A HREF="ds_getvui_hash.html">VUI Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example copies an existing VUI to a new 
          VUI. I.e. it simply re-saves the VUI link under
          a new name. </I></BLOCKQUOTE>

      <PRE>
      ($v = ars_GetVUI( $c, "Schema", $vuiId )) ||
	    die $ars_errstr;
      $v->{vuiId}   = $v->{vuiId} + 100000;
      $v->{vuiName} = "Copy of ".$v->{vuiName};
      ars_CreateVUI( $c, "Schema", $v ) || die $ars_errstr;
      </PRE>

Notes: Hash keys <CODE>helpText, owner</CODE> and 
<CODE>changeDiary</CODE> are optional when calling this routine.

This function was introduced in version 1.90 of ARSperl

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_SetSchema.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_SetSchema</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_SetSchema(ctrl, name, schemaHash)</CODE></H2>

      This function modifies an existing schema. You must first
      populate the <CODE>schemaHash</CODE> before calling this routine.
      <P><CODE>name</CODE> is the schema name.
      <P><CODE>schemaHash</CODE> is a
      <A HREF="ds_schema.html">Schema Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example copies an existing schema to a new 
          schema. I.e. it simply re-saves the schema under
          a new name. </I></BLOCKQUOTE>

      <PRE>
      ($a = ars_GetSchema($c, "AL-foobar")) ||
	    die $ars_errstr;
      $a->{name} = "Copy of ".$a->{name};
      ars_SetSchema($c, $name, $a) || die $ars_errstr;
      </PRE>

<P>
<I>This function was introduced in version 1.90 of ARSperl</I>
<P>

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_SetFilter.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_SetFilter</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_SetFilter(ctrl, name, filterHash)</CODE></H2>

      This function modifies an existing filter. You must first
      populate the <CODE>filterHash</CODE> before calling this routine.
      <P><CODE>name</CODE> is the name of the filter.
      <P><CODE>filterHash</CODE> is a 
      <A HREF="ds_getfilter_hash.html">Filter Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example changes the name and execution order of an existing filter. </I></BLOCKQUOTE>

      <PRE>
      ($f = ars_GetFilter($c, "TEST:Filter")) ||
	    die $ars_errstr;

      ars_SetFilter( $c, $f->{name}, {
        name  => $f->{name} . "(renamed)",
        order => $f->{order} + 100,
      } ) || die $ars_errstr;
      </PRE>

<P>
<I>This function was introduced in version 1.90 of ARSperl</I>
<P>

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_SetActiveLink.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_SetActiveLink</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_SetActiveLink(ctrl, name, activeLinkHash)</CODE></H2>

      This function modifies an existing active link. You must first
      populate the <CODE>activeLinkHash</CODE> before calling this routine.
      <P><CODE>name</CODE> is the name of the active link.
      <P><CODE>activeLinkHash</CODE> is a partially assigned
      <A HREF="ds_al.html">Active Link Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example changes the name and execution mask of an existing 
      active link. </I></BLOCKQUOTE>

      <PRE>
      ($al = ars_GetActiveLink($c, "TEST:ActiveLink")) ||
	    die $ars_errstr;

      ars_SetActiveLink( $c, $al->{name}, {
        name        => $al->{name} . "(renamed)",
        executeMask => 1 + 16,    # button, display
      } ) || die $ars_errstr;
      </PRE>

<P>
<I>This function was introduced in version 1.90 of ARSperl</I>
<P>

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
Index: ars_CreateActiveLink.html
===================================================================
RCS file: /cvsroot/arsperl/ARSperl/html/manual/ars_CreateActiveLink.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** ars_CreateActiveLink.html	4 Sep 1997 00:12:13 -0000	1.1
--- ars_CreateActiveLink.html	6 Mar 2007 01:54:26 -0000	1.2
***************
*** 9,13 ****
        This function creates an new active link. You must first
        populate the <CODE>activeLinkHash</CODE> before calling this routine.
!       <CODE>activeLinkHash</CODE> is an 
        <A HREF="ds_al.html">Active Link Attributes</a> hash. 

--- 9,13 ----
        This function creates an new active link. You must first
        populate the <CODE>activeLinkHash</CODE> before calling this routine.
!       <P><CODE>activeLinkHash</CODE> is an 
        <A HREF="ds_al.html">Active Link Attributes</a> hash. 

***************
*** 29,36 ****

        <PRE>
!       ($a = ars_GetActiveLink($c, "AL-foobar")) ||
  	    die $ars_errstr;
!       $a->{name} = "Copy of ".$a->{name};
!       ars_CreateActiveLink($c, $a) || die $ars_errstr;
        </PRE>

--- 29,36 ----

        <PRE>
!       ($al = ars_GetActiveLink($c, "AL-foobar")) ||
  	    die $ars_errstr;
!       $al->{name} = "Copy of ".$al->{name};
!       ars_CreateActiveLink($c, $al) || die $ars_errstr;
        </PRE>

--- NEW FILE: ars_CreateSchema.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_CreateSchema</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_CreateSchema(ctrl, schemaHash)</CODE></H2>

      This function creates a new schema. You must first
      populate the <CODE>schemaHash</CODE> before calling this routine.
      <P><CODE>schemaHash</CODE> is an 
      <A HREF="ds_schema.html">Schema Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example copies an existing schema to a new 
          schema. I.e. it simply re-saves the active link under
          a new name. </I></BLOCKQUOTE>

      <PRE>
      ($s = ars_GetSchema($c, "F-foobar")) ||
	    die $ars_errstr;
      $s->{name} = "Copy of ".$s->{name};
      ars_CreateSchema( $c, $s ) || die $ars_errstr;
      </PRE>

Notes: Hash keys <CODE>helpText, owner</CODE> and 
<CODE>changeDiary</CODE> are optional when calling this routine.

This function was introduced in version 1.90 of ARSperl

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_SetField.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_SetField</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_SetField(ctrl, schema, fieldId, fieldHash)</CODE></H2>

      This function modifies an existing field. You must first
      populate the <CODE>fieldHash</CODE> before calling this routine.
      <P><CODE>schema</CODE> is the name of the schema containing the field.
      <P><CODE>fieldId</CODE> is numeric id of the field.
      <P><CODE>fieldHash</CODE> is an 
      <A HREF="ds_field_hash.html">Field Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example increases the content length of a character field. It also specifies
      write permission for group 505 and read permission for group 506.
      </I></BLOCKQUOTE>

      <PRE>
      ($fd = ars_GetField($c, "Schema", $fieldId )) ||
	    die $ars_errstr;

      $fd->{limit}{maxLength} += 30;

      ars_SetField( $c, "Schema", $fieldId, {
        permissions => { 505 => "change", 506 => "view" },
        limit       => $fd->{limit},
      } ) || die $ars_errstr;
      </PRE>

<P>
<I>This function was introduced in version 1.90 of ARSperl</I>
<P>

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
Index: toc.html
===================================================================
RCS file: /cvsroot/arsperl/ARSperl/html/manual/toc.html,v
retrieving revision 1.24
retrieving revision 1.25
diff -C2 -d -r1.24 -r1.25
*** toc.html	3 Feb 2007 02:33:11 -0000	1.24
--- toc.html	6 Mar 2007 01:54:27 -0000	1.25
***************
*** 64,71 ****
--- 64,79 ----
  <P>
  <UL>
+ <LI><A HREF="ars_BeginBulkEntryTransaction.html">ars_BeginBulkEntryTransaction</A>
  <LI><A HREF="ars_CreateActiveLink.html">ars_CreateActiveLink</A>
  <LI><A HREF="ars_CreateAdminExtension.html">ars_CreateAdminExtension</A> <B>(2.x/3.0)</B>
  <LI><A HREF="ars_CreateAlertEvent.html">ars_CreateAlertEvent</A>
+ <LI><A HREF="ars_CreateCharMenu.html">ars_CreateCharMenu</A>
+ <LI><A HREF="ars_CreateContainer.html">ars_CreateContainer</A>
  <LI><A HREF="ars_CreateEntry.html">ars_CreateEntry</A>
+ <LI><A HREF="ars_CreateEscalation.html">ars_CreateEscalation</A>
+ <LI><A HREF="ars_CreateField.html">ars_CreateField</A>
+ <LI><A HREF="ars_CreateFilter.html">ars_CreateFilter</A>
+ <LI><A HREF="ars_CreateSchema.html">ars_CreateSchema</A>
+ <LI><A HREF="ars_CreateVUI.html">ars_CreateVUI</A>
  <LI><A HREF="ars_DecodeAlertMessage.html">ars_DecodeAlertMessage</A>
  <LI><A HREF="ars_DeleteActiveLink.html">ars_DeleteActiveLink</A>
***************
*** 81,84 ****
--- 89,93 ----
  <LI><A HREF="ars_DeleteVUI.html">ars_DeleteVUI</A>
  <LI><A HREF="ars_DeregisterForAlerts.html">ars_DeregisterForAlerts</A>
+ <LI><A HREF="ars_EndBulkEntryTransaction.html">ars_EndBulkEntryTransaction</A>
  <LI><A HREF="ars_ExecuteAdminExtension.html">ars_ExecuteAdminExtension</A>
  <LI><A HREF="ars_ExecuteProcess.html">ars_ExecuteProcess</A>
***************
*** 137,144 ****
  <LI><A HREF="ars_NTTerminationServer.html">ars_NTTerminationServer</A> <B>(3.x)</B>
  <LI><A HREF="ars_RegisterForAlerts.html">ars_RegisterForAlerts</A>
  <LI><A HREF="ars_SetEntry.html">ars_SetEntry</A>
  <LI><A HREF="ars_SetLogging.html">ars_SetLogging</A>
  <LI><A HREF="ars_SetServerInfo.html">ars_SetServerInfo</A>
! 
  </UL>
  <P>    
--- 146,162 ----
  <LI><A HREF="ars_NTTerminationServer.html">ars_NTTerminationServer</A> <B>(3.x)</B>
  <LI><A HREF="ars_RegisterForAlerts.html">ars_RegisterForAlerts</A>
+ <LI><A HREF="ars_SetActiveLink.html">ars_SetActiveLink</A>
+ <LI><A HREF="ars_SetCharMenu.html">ars_SetCharMenu</A>
+ <LI><A HREF="ars_SetContainer.html">ars_SetContainer</A>
  <LI><A HREF="ars_SetEntry.html">ars_SetEntry</A>
+ <LI><A HREF="ars_SetEscalation.html">ars_SetEscalation</A>
+ <LI><A HREF="ars_SetField.html">ars_SetField</A>
+ <LI><A HREF="ars_SetFilter.html">ars_SetFilter</A>
+ <LI><A HREF="ars_SetImpersonatedUser.html">ars_SetImpersonatedUser</A>
  <LI><A HREF="ars_SetLogging.html">ars_SetLogging</A>
+ <LI><A HREF="ars_SetSchema.html">ars_SetSchema</A>
  <LI><A HREF="ars_SetServerInfo.html">ars_SetServerInfo</A>
! <LI><A HREF="ars_SetSessionConfiguration.html">ars_SetSessionConfiguration</A>
! <LI><A HREF="ars_SetVUI.html">ars_SetVUI</A>
  </UL>
  <P>    

--- NEW FILE: ars_SetEscalation.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_SetEscalation</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_SetEscalation(ctrl, name, escalationHash)</CODE></H2>

      This function modifies an existing escalation. You must first
      populate the <CODE>escalationHash</CODE> before calling this routine.

      <P><CODE>name</CODE> is the name of the escalation.
      <P><CODE>escalationHash</CODE> is a partially assigned
      <A HREF="ds_getescalation_hash.html">Escalation Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example changes the name and disables 
      the escalation "TEST:Escalation". </I></BLOCKQUOTE>

      <PRE>
      ars_SetEscalation( $c, "TEST:Escalation", {
        name   => "# TEST:Escalation",
        enable => 0,
      } ) || die $ars_errstr;
      </PRE>

<P>
<I>This function was introduced in version 1.90 of ARSperl</I>
<P>

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_CreateEscalation.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_CreateEscalation</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_CreateEscalation(ctrl, escalationHash)</CODE></H2>

      This function creates a new escalation. You must first
      populate the <CODE>escalationHash</CODE> before calling this routine.
      <P><CODE>escalationHash</CODE> is an 
      <A HREF="ds_getescalation_hash.html">Escalation Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example copies an existing escalation to a new 
          escalation. I.e. it simply re-saves the escalation under
          a new name. </I></BLOCKQUOTE>

      <PRE>
      ($e = ars_GetEscalation($c, "E-foobar")) ||
	    die $ars_errstr;
      $e->{name} = "Copy of ".$e->{name};
      ars_CreateEscalation($c, $e) || die $ars_errstr;
      </PRE>

Notes: Hash keys <CODE>helpText, owner</CODE> and 
<CODE>changeDiary</CODE> are optional when calling this routine.

This function was introduced in version 1.90 of ARSperl

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_EndBulkEntryTransaction.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Manual - ars_EndBulkEntryTransaction</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_EndBulkEntryTransaction(ctrl,actionType)</CODE></H2>

Starts or cancels the execution of the entry operations that have been called since the 
former <a href="ars_BeginBulkEntryTransaction.html">ars_BeginBulkEntryTransaction</a> call.

   <p>The <code>actionType</code> parameter specifies if the operations of the transaction
   will be cancelled or sent to the server for execution:
	<UL> 
	  AR_BULK_ENTRY_ACTION_SEND = send the queued entry calls to the server<br>
      AR_BULK_ENTRY_ACTION_CANCEL = cancel the transaction<br>
	</UL>

      <DL>
         <DT><B>On success</B><DD>
		   Returns a list of return structures corresponding to the
		   operations 
         <DT><B>On failure</B><DD>
           Returns an empty list
      </DL>

      <P>Example:

      <PRE>
	      @results = ars_EndBulkEntryTransaction( $ctrl, $actionType ); 
			die "$ars_errstr" if ! $results;
      </PRE>

<P>
<I>ars_EndBulkEntryTransaction was introduced in version 1.90 of ARSperl</I>

<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 22th February 2007 by ts...@us...<BR>
&#169; J.C.Murphy, J.W.Murphy, T.Stapff 2007 ar...@ar...
</address>
</BODY>
</HTML>

--- NEW FILE: ars_BeginBulkEntryTransaction.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Manual - ars_BeginBulkEntryTransaction</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_BeginBulkEntryTransaction(ctrl)</CODE></H2>

This command can be used to group several create, set, delete and merge
entry operations together into a single transaction. The actual execution
of these functions is deferred until
<a href="ars_EndBulkEntryTransaction.html">ars_EndBulkEntryTransaction</a> is called.

      <DL>
         <DT><B>On success</B><DD>
		   Returns 1
         <DT><B>On failure</B><DD>
           Returns 0
      </DL>

      <P>Example:

      <PRE>
	      ars_BeginBulkEntryTransaction( $ctrl ) || die "$ars_errstr";
      </PRE>

<P>
<I>ars_BeginBulkEntryTransaction was introduced in version 1.90 of ARSperl</I>

<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 22th February 2007 by ts...@us...<BR>
&#169; J.C.Murphy, J.W.Murphy, T.Stapff 2007 ar...@ar...
</address>
</BODY>
</HTML>

--- NEW FILE: ars_CreateField.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_CreateField</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_CreateField(ctrl, schema, fieldHash, reservedIdOK=0 )</CODE></H2>

      This function creates a new field. You must first
      populate the <CODE>fieldHash</CODE> before calling this routine.
      <P><CODE>schema</CODE> is the name of the schema where the field is to be created.
      <P><CODE>fieldHash</CODE> is a
      <A HREF="ds_field_hash.html">Field Properties Structure</a> hash. 
      <P><CODE>reservedIdOK</CODE> must be set to 1 if you want to create a field in
      the reserved field id range (i.e. <= 536870912).

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example copies an existing field to a new 
          field. I.e. it simply re-saves the field under
          a new name. </I></BLOCKQUOTE>

      <PRE>
      ($fd = ars_GetField($c, "Schema", 536870913)) ||
	    die $ars_errstr;
      $fd->{fieldId}   = $fd->{fieldId} + 100000;
      $fd->{fieldName} = "Copy of ".$fd->{fieldName};
      ars_CreateField( $c, "Schema", $fd ) || die $ars_errstr;
      </PRE>

Notes: Hash keys <CODE>helpText, owner</CODE> and 
<CODE>changeDiary</CODE> are optional when calling this routine.
<CODE>fieldId</CODE> can be specified as 0 if you want the the server
to generate a field id.

This function was introduced in version 1.90 of ARSperl

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_SetVUI.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_SetVUI</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_SetVUI(ctrl, vuiHash)</CODE></H2>

      This function modifies an existing VUI. You must first
      populate the <CODE>vuiHash</CODE> before calling this routine.
      <P><CODE>vuiHash</CODE> is an 
      <A HREF="ds_getvui_hash.html">VUI Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example changes the owner of the view "TEST:View". 
      </I></BLOCKQUOTE>

      <PRE>
      ($v = ars_GetVUI($c,"Schema",$vuiId)) ||
	    die $ars_errstr;
      ars_SetVUI( $c, "Schema", $vuiId, {owner => "admin2"} ) || die $ars_errstr;
      </PRE>

<P>
<I>This function was introduced in version 1.90 of ARSperl</I>
<P>

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_SetCharMenu.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_SetCharMenu</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_SetCharMenu(ctrl, name, menuHash)</CODE></H2>

      This function modifies an existing menu. You must first
      populate the <CODE>menuHash</CODE> before calling this routine.

      <P>
      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example changes the name and the refresh code of the menu "TEST:CharMenu".
      </I></BLOCKQUOTE>

      <PRE>
      ars_SetCharMenu( $c, "TEST:CharMenu, {
        name        => "TEST:CharMenu2",
        refreshCode => "open",
      } ) || die $ars_errstr;
      </PRE>

<P>
<I>This function was introduced in version 1.90 of ARSperl</I>
<P>

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_SetContainer.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_SetContainer</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_SetContainer(ctrl, name, containerHash)</CODE></H2>

      This function modifies an existing container. You must first
      populate the <CODE>containerHash</CODE> before calling this routine.
      <P><CODE>name</CODE> is the name of the container.
      <P><CODE>containerHash</CODE> is a partially assigned
      <A HREF="ds_container.html">Container Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example changes the name of the container "TEST:FilterGuide". 
      It also adds a filter to the end of the list.</I></BLOCKQUOTE>

      <PRE>
      ($ct = ars_GetContainer($c, "TEST:FilterGuide")) ||
	    die $ars_errstr;

      push @{$ct->{referenceList}}, {
        type => 3,
        name => "TEST:Filter",
        dataType => 0,
        description => "",
        label => "",
      };

      ars_SetContainer( $c, "TEST:FilterGuide", {
        name => "TEST:FilterGuide 2",
        referenceList => $ct->{referenceList},
      } ) || die $ars_errstr;
      </PRE>

<P>
<I>This function was introduced in version 1.90 of ARSperl</I>
<P>

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_CreateFilter.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Programmer's Manual - ars_CreateFilter</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_CreateFilter(ctrl, filterHash)</CODE></H2>

      This function creates a new filter. You must first
      populate the <CODE>filterHash</CODE> before calling this routine.
      <P><CODE>filterHash</CODE> is a
      <A HREF="ds_getfilter_hash.html">Filter Attributes</a> hash. 

      <P>

      <DL>
          <DT><B>On success</B><DD>
              Returns 1
          <DT><B>On failure</B><DD>
              Returns 0
      </DL>

      <P>Example:

      <P><BLOCKQUOTE>
      <I> This example copies an existing filter to a new 
          filter. I.e. it simply re-saves the filter under
          a new name. </I></BLOCKQUOTE>

      <PRE>
      ($f = ars_GetFilter($c, "F-foobar")) ||
	    die $ars_errstr;
      $f->{name} = "Copy of ".$f->{name};
      ars_CreateFilter($c, $f) || die $ars_errstr;
      </PRE>

Notes: Hash keys <CODE>helpText, owner</CODE> and 
<CODE>changeDiary</CODE> are optional when calling this routine.

This function was introduced in version 1.90 of ARSperl

<A HREF="toc.html"><IMG ALT="&lt;--" SRC="arrow.gif" ALIGN=CENTER> Back to Table of Contents </A>
</BODY>
</HTML>
--- NEW FILE: ars_SetImpersonatedUser.html ---
<HTML>
<HEAD>
<TITLE>ARSperl Manual - ars_SetServerInfo</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

   <H2><CODE>ars_SetImpersonatedUser(ctrl,loginName)</CODE></H2>

      This function enables an API program running under an administrator login
      to perform certain operations as a specific user.

      <P><CODE>loginName</CODE> is the login name of the impersonated user.
      Use "" (i.e. the empty string) to switch back to the admin user.

      <DL>
         <DT><B>On success</B><DD>
		   Returns 1
         <DT><B>On failure</B><DD>
           Returns 0
      </DL>

      <P>Example:

      <PRE>
	      ars_SetImpersonatedUser($ctrl,"TestUser") || die "$ars_errstr";
      </PRE>

<P>
<I>ars_SetImpersonatedUser was introduced in version 1.90 of ARSperl</I>

<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 22th February 2007 by ts...@us...<BR>
&#169; J.C.Murphy, J.W.Murphy, T.Stapff 2007 ar...@ar...
</address>
</BODY>
</HTML>