home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 1.2 / amidev_cd_12.iso / contrib / iam / networking / envoy-2.0 / doc / envoy.doc < prev    next >
Encoding:
Text File  |  1994-12-22  |  7.0 KB  |  209 lines
  1. TABLE OF CONTENTS
  2.  
  3. envoy.library/HostRequestA
  4. envoy.library/LoginRequestA
  5. envoy.library/UserRequestA
  6. envoy.library/HostRequestA                         envoy.library/HostRequestA
  7.  
  8.    NAME
  9.      HostRequestA -- Create a std. requester for selecting a host
  10.  
  11.    SYNOPSIS
  12.      ret = HostRequestA(taglist)
  13.      D0                   A0
  14.  
  15.      BOOL  HostRequestA(struct TagList *);
  16.      BOOL  HostRequest(tag1, tag2, ...);
  17.  
  18.    FUNCTION
  19.      Creates a system requester that allows the user to search for and
  20.      select the different hosts and realms known on your network.
  21.  
  22.    INPUTS
  23.      taglist - Made up of the following possible tags:
  24.  
  25.            HREQ_Buffer   - Specifies a pointer to the buffer where you wish
  26.                            the resolved host and/or realm name to be stored
  27.                            when the user selected "OK".
  28.  
  29.                            If a given machine exists in a realm, the string
  30.                            returned will be "realmname:hostname".
  31.  
  32.            HREQ_BuffSize - Maximum number of bytes allowed to be copied into
  33.                            the above buffer.
  34.  
  35.            HREQ_Left     - Initial left coordinate of the requester.
  36.  
  37.            HREQ_Top      - Initial top coordinate of the requester.
  38.  
  39.            HREQ_Width    - Horizontal size of requester in pixels.
  40.  
  41.            HREQ_Height   - Vertical size of requester in pixels.
  42.  
  43.            HREQ_DefaultRealm -
  44.                            Defines the realm to initially search for machines
  45.                            in when the requester first appears.  (String
  46.                            should NOT include a ':'.)
  47.  
  48.            HREQ_NoRealms - Removes the 'realms' button, and prevents users
  49.                            from switching realms by typing "realm:" in the
  50.                            string gadget.  The response will only contain a
  51.                            hostname.
  52.  
  53.            HREQ_Screen   - Defines the screen on which this requester
  54.                            should be created.  If not provided, it will be
  55.                            opened on the workbench screen.
  56.  
  57.            HREQ_Title    - Provides the name for the title bar of the
  58.                            requester's window.
  59.  
  60.            HREQ_NoResizer -
  61.                            Prevents the requester's window from opening
  62.                            with a resizer gadget; the requester will be
  63.                            locked in at the initial size.
  64.            HREQ_NoDragBar -
  65.                            Prevents the requester's window from opening
  66.                            with a dragbar gadget; the requester will be
  67.                            locked in at the original position.
  68.  
  69.            MATCH_ ...      Any of the MATCH tags for
  70.                            nipc.library/NIPCInquiry() can be included, and
  71.                            will be used to limit hosts that appear to
  72.                            those that meet the given criteria.
  73.  
  74.    RESULT
  75.      ret - either TRUE or FALSE, representing whether the requester was
  76.            successful or not.
  77.  
  78.    EXAMPLE
  79.  
  80.    NOTES
  81.  
  82.    BUGS
  83.      Had problems with arbitrary fonts prior to 40.9. No workaround.
  84.  
  85.    SEE ALSO
  86.      nipc.library/NIPCInquiry, nipc.library/GetHostName
  87.  
  88. envoy.library/LoginRequestA                       envoy.library/LoginRequestA
  89.  
  90.    NAME
  91.      LoginRequestA -- Create a std. requester for name and password
  92.  
  93.    SYNOPSIS
  94.      ret = LoginRequestA(taglist)
  95.      D0                   A0
  96.  
  97.      BOOL  LoginRequestA(struct TagList *);
  98.      BOOL  LoginRequest(tag1, tag2, ...);
  99.  
  100.    FUNCTION
  101.      Creates a system requester that allows the user to enter his name
  102.      and password.
  103.  
  104.    INPUTS
  105.      taglist - Made up of the following possible tags:
  106.  
  107.            LREQ_NameBuff - Specifies a pointer to the buffer where you wish
  108.                            the user's name name to be stored when the user
  109.                            selects "OK".
  110.  
  111.            LREQ_NameBuffLen - Maximum number of bytes allowed to be
  112.                            copied into the above buffer.
  113.  
  114.            LREQ_PassBuff - Specifies a pointer the buffer where you wish
  115.                            the user's password to be stored when the user
  116.                            selects "OK".
  117.  
  118.            LREQ_PassBuffLen - Maxmimum number of bytes allowed to be copied
  119.                            into the above buffer.
  120.  
  121.            LREQ_Left     - Initial left coordinate of the requester.
  122.  
  123.            LREQ_Top      - Initial top coordinate of the requester.
  124.  
  125.            LREQ_Width    - Horizontal size of requester in pixels.
  126.  
  127.            LREQ_Height   - Vertical size of requester in pixels.
  128.  
  129.            LREQ_Screen   - Defines the screen on which this requester
  130.                            should be created.  If not provided, it will be
  131.                            opened on the workbench screen.
  132.  
  133.            LREQ_Title    - Provides the name for the title bar of the
  134.                            requester's window.
  135.  
  136.            LREQ_NoDragBar -
  137.                            Prevents the requester's window from opening
  138.                            with a dragbar gadget; the requester will be
  139.                            locked in at the original position.
  140.  
  141.    RESULT
  142.      ret - either TRUE or FALSE, representing whether the requester was
  143.            successful or not.
  144.  
  145.    EXAMPLE
  146.  
  147.    NOTES
  148.  
  149.    BUGS
  150.  
  151.  
  152. envoy.library/UserRequestA                         envoy.library/UserRequestA
  153.  
  154.    NAME
  155.      UserRequestA -- Create a std. requester for choosing a user.
  156.  
  157.    SYNOPSIS
  158.      ret = UserRequestA(taglist)
  159.      D0                   A0
  160.  
  161.      BOOL  UserRequestA(struct TagList *);
  162.      BOOL  UserRequest(tag1, tag2, ...);
  163.  
  164.    FUNCTION
  165.      Creates a system requester that allows the user to choose a username
  166.      from a list of available users on his system.
  167.  
  168.    INPUTS
  169.      taglist - Made up of the following possible tags:
  170.  
  171.            UGREQ_NameBuff - Specifies a pointer to the buffer where you wish
  172.                            the user's name name to be stored when the user
  173.                            selects "OK".
  174.  
  175.            UGREQ_NameBuffLen - Maximum number of bytes allowed to be
  176.                            copied into the above buffer.
  177.  
  178.            UGREQ_Left     - Initial left coordinate of the requester.
  179.  
  180.            UGREQ_Top      - Initial top coordinate of the requester.
  181.  
  182.            UGREQ_Width    - Horizontal size of requester in pixels.
  183.  
  184.            UGREQ_Height   - Vertical size of requester in pixels.
  185.  
  186.            UGREQ_Screen   - Defines the screen on which this requester
  187.                            should be created.  If not provided, it will be
  188.                            opened on the workbench screen.
  189.  
  190.            UGREQ_Title    - Provides the name for the title bar of the
  191.                            requester's window.
  192.  
  193.            UGREQ_NoDragBar -
  194.                            Prevents the requester's window from opening
  195.                            with a dragbar gadget; the requester will be
  196.                            locked in at the original position.
  197.  
  198.    RESULT
  199.      ret - either TRUE or FALSE, representing whether the requester was
  200.            successful or not.
  201.  
  202.    EXAMPLE
  203.  
  204.    NOTES
  205.  
  206.    BUGS
  207.  
  208.  
  209.