VMS Help LGI Routines, LGI$ICB_USERPROMPT  *Conan The Librarian (sorry for the slow response - running on an old VAX)

    The LGI$ICB_USERPROMPT callback routine prompts for the user
    name.

    Format

      LGI$ICB_USERPROMPT  prompt

1 - Returns

    OpenVMS usage:cond_value
    type:         longword (unsigned)
    access:       write only
    mechanism:    by value

    Condition value in R0.

2 - Argument

 prompt

    OpenVMS usage:character string
    type:         string descriptor
    access:       read only
    mechanism:    by reference
    A string that must begin with "cr,lf". For example, to produce
    the standard user name prompt, use your language equivalent of
    the following BLISS value:

     UPLIT(12,UPLIT BYTE(CR,LF,'Username: '))

    Declare the string in C using the following statement:

    $DESCRIPTOR(<variable_name>, "lrlnUsername:")

    You then pass the descriptor using the variable name.

    This routine also produces the standard user name prompt if you
    pass the value 0 for this argument.

3 - Description

    Use this callback routine to interactively prompt for the user
    name on a character-cell terminal. The callback routine reads
    the response to the prompt and does standard DCL parsing for the
    user name and any qualifiers provided. Upon completion of this
    routine, the user name is accessible at the LGI$A_USERNAME entry
    in the standard arguments vector.

4 - Condition Values Returned

    SS$_NORMAL         Success.
    LGI$_NOTVALID      Retry count exceeded for user input.