Contents page

Index

RTGetString

  NAME RTGetString()


    ULONG ret = RTGetString(UBYTE *buffer, ULONG maxchars, char *title,
                            struct rtReqInfo *reqinfo);


    ULONG ret = RTGetString(ULONG *buffer, ULONG maxchars, char *title,
                            struct rtReqInfo *reqinfo, ULONG *taglist);


  DESCRIPTION
    Puts up a string requester to get a line of text from the user.
    The string present in 'buffer' upon entry will be displayed, ready to
    be edited.


    'reqinfo' can be used to customize the requester.  For greater control
    use the tags listed below.  The advantage of the rtReqInfo structure is
    that it is global, where tags have to be specified each function call.
    See libraries/reqtools.[hi] for a description of the rtReqInfo structure.


  NOTE
    The contents of the buffer will NOT change if the requester is aborted.


    See reqtools developer documentation for descriptions of tag items which
    can be used with RTFileRequestA


  INPUTS
    buffer   - pointer to buffer to hold characters entered.
    maxchars - maximum number of characters that fit in buffer (EX-cluding
               the 0 to terminate the string !).
    title    - pointer to null terminated title of requester window.
    reqinfo  - pointer to a rtReqInfo structure allocated with
               rtAllocRequest() or NULL.
    taglist  - pointer to a TagItem array.


  RESULT
    ret - TRUE if user entered a number, FALSE if not. If one of your idcmp
          flags caused the requester to end 'ret' will hold this flag.
          If you used the RTGL_GadFmt tag the return code will hold the
          value of the response as with rtEZRequestA().


  BUGS
    none known


  SEE ALSO
    AFReqTools buffer member