home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR19 / RLIBDOC.ZIP / NOVCLIP.DOC next >
Text File  |  1993-08-20  |  6KB  |  221 lines
  1. -----------------------------------------------------------------------------
  2. Function:    NWConnectId()
  3.  
  4. Purpose:     Retrieve the workstation connection number.
  5.  
  6. Syntax:      NWConnectId()
  7.  
  8. Arguments:   None
  9.  
  10. Returns:     Connection number as a Clipper numeric value.
  11.  
  12. Description: This function returns the connection number of the calling
  13.              workstation as a numeric value.  The connection number is
  14.              only valid and/or meaningful when the requesting station
  15.              is logged into a server.  First check if the station is
  16.              logged into a server with the function NWLoggedIn().
  17.  
  18. Notes:       The connection number is for the default file server.
  19.  
  20. Example:     LOCAL station := NWConnectId()
  21.              ? "You are logged in on station number:", station
  22.  
  23. See also:    NWIPXLoaded(), NWLoggedIn(), NWShellLoaded()
  24.  
  25. Source:      NOVCLIP.C
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32. -----------------------------------------------------------------------------
  33. Function:    NWFullName()
  34.  
  35. Purpose:     Get the full name of the user logged into the current station.
  36.  
  37. Syntax:      NWFullName()
  38.  
  39. Arguments:   None
  40.  
  41. Returns:     The full name of the user logged into the requesting station.
  42.  
  43. Description: This function returns the user name of the user (object) that
  44.              is logged into the requesting workstation.  The user name is
  45.              that which is stored in the bindery as maintained by the
  46.              supervisor.
  47.  
  48. Notes:       The name returned is for the connection to the default file
  49.              server.
  50.  
  51. Example:     LOCAL userName := NWFullName()
  52.              ? "Hello " + userName
  53.  
  54. See also:    NWLoginId, NWLoginTime()
  55.  
  56. Source:      NOVCLIP.C
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63. -----------------------------------------------------------------------------
  64. Function:    NWIPXLoaded()
  65.  
  66. Purpose:     Determine if IPX is loaded on the requesting workstation
  67.  
  68. Syntax:      NWIPXLoaded()
  69.  
  70. Arguments:   None
  71.  
  72. Returns:     True if IPX is loaded on the requesting workstation.
  73.  
  74. Description: This function tests to see if IPX has been loaded.
  75.  
  76. Notes:       This function makes an interrupt call to IPX to test for
  77.              its presence.
  78.  
  79. Example:     IF .NOT. NWIPXLoaded()
  80.                 ? "IPX is not loaded.  Please load IPX then NETx."
  81.              ENDIF
  82.  
  83. See also:    NWLoggedIn(), NWShellLoaded()
  84.  
  85. Source:      NOVCLIP.C
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92. -----------------------------------------------------------------------------
  93. Function:    NWLoggedIn()
  94.  
  95. Purpose:     Determine if the calling workstation is logged in to a server.
  96.  
  97. Syntax:      NWLoggedIn()
  98.  
  99. Arguments:   None
  100.  
  101. Returns:     True if the calling workstation is currently logged into a
  102.              NetWare file server.
  103.  
  104. Description: This function lets you determine if the calling workstation
  105.              is currently logged into a NetWare file server.  The station
  106.              may be attached but not logged in, in which case NWLoggedIn()
  107.              will return False.
  108.  
  109. Notes:       NWLoggedIn() makes a call to GetConnectionInfo() and returns
  110.              the result.  GetConnectionInfo() returns a non-zero value on
  111.              success.
  112.  
  113. Example:     IF .NOT. NWLoggedIn()
  114.                 ? "Network files are not available, please login."
  115.              ENDIF
  116.  
  117. See also:    NWLoginId()
  118.  
  119. Source:      NOVCLIP.C
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126. -----------------------------------------------------------------------------
  127. Function:    NWLoginId()
  128.  
  129. Purpose:     Retrieve the login id (user name) of the current station.
  130.  
  131. Syntax:      NWLoginId()
  132.  
  133. Arguments:   None
  134.  
  135. Returns:     The user login ID as a Clipper character string.
  136.  
  137. Description: This function returns the login id (name) of the user logged
  138.              in at the requestion workstation.  The login id is not to be
  139.              confused with the login user full name.  The login id is the
  140.              name specified when logging in to a NetWare file server.
  141.  
  142. Notes:       The name returned is for the connection to the default file
  143.              server.
  144.  
  145. Example:     ? " User: " + NWLoginId() +;
  146.                " logged into station #" + LTRIM(STR(NWConnectId())) +;
  147.                " at " + NWLoginTime()
  148.  
  149. See also:    NWFullName(), NWLoginTime()
  150.  
  151. Source:      NOVCLIP.C
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158. -----------------------------------------------------------------------------
  159. Function:    NWLoginTime()
  160.  
  161. Purpose:     Retrieve the login time of the current connection
  162.  
  163. Syntax:      NWLoginTime()
  164.  
  165. Arguments:   None
  166.  
  167. Returns:     Login time as a Clipper character string, format HH:MM:SS
  168.  
  169. Description: This function returns the time that the requesting station
  170.              last logged into the file server.  The time is returned as
  171.              a character string in the same format as the TIME() function.
  172.  
  173. Notes:       The time returned is for the connection to the default file
  174.              server.
  175.  
  176. Example:     ? " User: " + NWLoginId() +;
  177.                " logged into station #" + LTRIM(STR(NWConnectId())) +;
  178.                " at " + NWLoginTime()
  179.  
  180. See also:    NWConnectId(), NWLoginId()
  181.  
  182. Source:      NOVCLIP.C
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189. -----------------------------------------------------------------------------
  190. Function:    NWShellLoaded()
  191.  
  192. Purpose:     Determine if the NetWare shell (NETx) is loaded
  193.  
  194. Syntax:      NWShellLoaded()
  195.  
  196. Arguments:   None
  197.  
  198. Returns:     True if the NetWare shell is loaded on the workstation.
  199.  
  200. Description: This function is useful for determining if the NetWare
  201.              shell (NETx) is loaded.  If the shell is not loaded then
  202.              the workstation cannot login to and access a file server.
  203.  
  204. Notes:       This function makes a call to get the connection number
  205.              assigned to the shell.  An unchanged value (0) indicates
  206.              that the shell is not loaded or unavailable.
  207.  
  208. Example:     IF .NOT. NWShellLoaded()
  209.                 ? "The NetWare shell is not loaded"
  210.              ENDIF
  211.  
  212. See also:    NWIPXLoaded(), NWLoggedIn()
  213.  
  214. Source:      NOVCLIP.C
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.