[LON-CAPA-cvs] cvs: loncom /lonnet/perl lonnet.pm

[matthew]

matthew		Tue Sep 24 14:25:45 2002 EDT

  Modified files:              
    /loncom/lonnet/perl	lonnet.pm 
  Log:
  More POD documentation for modifystudent.  Each parameter is at least described
  now.  Hopefully the descriptions are correct.
  
  
Index: loncom/lonnet/perl/lonnet.pm
diff -u loncom/lonnet/perl/lonnet.pm:1.285 loncom/lonnet/perl/lonnet.pm:1.286
--- loncom/lonnet/perl/lonnet.pm:1.285	Tue Sep 17 17:19:19 2002
+++ loncom/lonnet/perl/lonnet.pm	Tue Sep 24 14:25:45 2002
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # TCP networking package
 #
-# $Id: lonnet.pm,v 1.285 2002/09/17 21:19:19 matthew Exp $
+# $Id: lonnet.pm,v 1.286 2002/09/24 18:25:45 matthew Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -3595,7 +3595,48 @@
 
 =item *
 
-modifystudent($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,$end,$start) : modify student
+modifystudent
+
+modify a students enrollment and identification information.
+The course id is resolved based on the current users environment.  
+This means the envoking user must be a course coordinator or otherwise
+associated with a course.
+
+This call is essentially a wrapper for lonnet::modifyuser
+
+Inputs: 
+
+=over 4
+
+=item B<$udom> Students loncapa domain
+
+=item B<$uname> Students loncapa login name
+
+=item B<$uid> Students id/student number
+
+=item B<$umode> Students authentication mode
+
+=item B<$upass> Students password
+
+=item B<$first> Students first name
+
+=item B<$middle> Students middle name
+
+=item B<$last> Students last name
+
+=item B<$gene> Students generation
+
+=item B<$usec> Students section in course
+
+=item B<$end> Unix time of the roles expiration
+
+=item B<$start> Unix time of the roles start date
+
+=item B<$forceid> If defined, allow $uid to be changed
+
+=item B<$desiredhome> server to use as home server for student
+
+=back
 
 =item *