[LON-CAPA-cvs] cvs: loncom /enrollment localenroll.pm

[raeburn]

raeburn		Sat Aug 25 14:35:20 2007 EDT

  Modified files:              
    /loncom/enrollment	localenroll.pm 
  Log:
  Update documentation for &get_userinfo()
  - begins added as a searchtype (look for matches which begin with the
    searchterm). 
  
  
Index: loncom/enrollment/localenroll.pm
diff -u loncom/enrollment/localenroll.pm:1.21 loncom/enrollment/localenroll.pm:1.22
--- loncom/enrollment/localenroll.pm:1.21	Wed Jul 25 16:43:48 2007
+++ loncom/enrollment/localenroll.pm	Sat Aug 25 14:35:17 2007
@@ -1,6 +1,6 @@
 # functions to glue school database system into Lon-CAPA for 
 # automated enrollment
-# $Id: localenroll.pm,v 1.21 2007/07/25 20:43:48 raeburn Exp $
+# $Id: localenroll.pm,v 1.22 2007/08/25 18:35:17 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -512,10 +512,16 @@
 ###############################
 # sub get_userinfo
 #
-# Incoming data: four required arguments and t optional arguments
-# Retrieves institutional data for a single user either by username
-# if $uname is included as second argument, or by ID if $id is 
-# included as a third argument.  Either (b) or (c) must be provided. 
+# Incoming data: four required arguments and additional optional argumenta
+# Two modes of operation:
+# (1) Retrieves institutional data for a single user either by username
+#     if $uname is included as second argument, or by ID if $id is 
+#     included as a third argument.  Either (b) or (c) must be provided.
+#     (g), (h) and (i) will be undefined.
+# (2) Retrieves institutional user data from search of an institutional
+#     directory based on a search. (g) and (h) are required.
+#     (i) is optional. (b) and (c) will be undefined. 
+#
 # (a) $dom - domain
 # (b) $uname - username of user
 # (c) $id - student/faculty ID of user
@@ -537,7 +543,8 @@
 #               2. lastname; 3. username
 # (h) $srchterm - optional if $uname or $id defined, otherwise required
 #                String to search for.
-# (i) $srchtype - optional. Allowed value: contains
+# (i) $srchtype - optional. Allowed values: contains, begins (defaults
+#                to exact match otherwise).
 #
 # returns 1 parameter - ('ok' or other value).
 # side effects - populates the $instusers and $instids refs to hashes.